🌐 AI搜索 & 代理 主页
Skip to content

chore(docs): minor updates to the carousel docs #3964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmorehouse merged 3 commits into from
Aug 28, 2019
Merged

chore(docs): minor updates to the carousel docs #3964

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
466df8f
chore(docs): minor updates to the carousel docs
tmorehouse Aug 28, 2019
bc710f0
Update README.md
jacobmllr95 Aug 28, 2019
3a5f089
Merge branch 'dev' into docs/carousel
jacobmllr95 Aug 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions src/components/carousel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,36 @@ Set the prop `indicators` to show the slide indicator buttons.

Both indicators and controls can be set at the same time or independently.

## Carousel slide content

`b-carousel-slide` provides several props and slots for placing content in the slide.

### Props

- `caption` Text to use as the main title on the slide (placed inside the inner element which has
the class `carousel-caption`)
- `text` Textual placed under the title (placed inside the inner element which has the class
`carousel-caption`)
- `img-src` URL of image to be placed into the background of the slide
- `caption-html` Alternate prop to the `caption` prop, which supports HTML strings
- `html` Alternate prop to the `text` prop, which supports HTML strings

<p class="alert alert-danger">
<strong>Warning:</strong> Be cautious of using the <code>caption-html</code> and <code>html</code>
props to display user supplied content, as it may make your application vulnerable to
<a class="alert-link" href="https://en.wikipedia.org/wiki/Cross-site_scripting">
<abbr title="Cross Site Scripting Attacks">XSS attacks</abbr></a>, if you do not first
<a class="alert-link" href="https://en.wikipedia.org/wiki/HTML_sanitization">sanitize</a> the
user supplied string.
</p>

### Named slots

- `default` content that will be placed inside of the inner element which has the class
`carousel-caption`. Appears after any content from the `caption` and `text` props.
- `img` content to place into the background of the slide. Despite the slot's name, you can place
almost any content in this slot in lieu of using the `default` slot or `caption` and `text` props.

## Carousel animation

Carousel, by default, uses a sliding animation. You can change the slide animation to a cross-fade
Expand Down