diff --git a/components/bl-carousel-component/README.md b/components/bl-carousel-component/README.md index 2fbda7fdd..52877d39a 100644 --- a/components/bl-carousel-component/README.md +++ b/components/bl-carousel-component/README.md @@ -1,21 +1,33 @@ # Carousel -Carousel is a component of Backendless UI-Builder designer. This allows you to add some image and switch between them. +Carousel component represents an area where you can add images and switch between them using control buttons. This component is based on [Bootstrap Carousel](https://getbootstrap.com/docs/5.2/components/carousel/). Available in the UI-Builder. -The component based on external [Carousel](https://getbootstrap.com/docs/5.2/components/carousel/). +

+ main thumbnail +

+ +Images for Carousel can be set in the Settings of the UI Builder. The component uses a list of JSON objects where base64-encoded images or URLs to images are stored. Besides the image data, the JSON object contains the **"title"** and the **"content"** properties to display text. As you can see in the image below, the base64-encoded image or the URL to the image is stored in the **"url"** property. + +

+ main thumbnail +

+ +You can also set images, titles and content by using the Codeless Logic presented below: + +![](example-images/imagesData-example.png) ## Properties -| Property | Type | Default Value | Logic | Data Binding | UI Setting | Description | -| ------------------------------------------- | --------------------------------------- | ------------------------------------- | --------------------------- | ------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Images Data:`imagesData` | JSON | [Defalut Value](#images-data-default) | Image Data Logic | YES | YES | Allows determinate data for carousel. Watch [Codeless Examples](#examples). Signature of polygon: `{"url": string, "title": string, "content": string }` | -| Height:`height` | Text | "400px" | Height Logic | YES | YES | Allows determinate height for images. | -| Width:`width` | Text | "700px" | Width Logic | YES | YES | Allows determinate width for images. | -| Autoplay Delay(ms):`autoplayDelay` | Number | 5000 | Autoplay Delay | YES | YES | Allows determinate delay(ms) for autoplay. | -| Animation Type:`animationType` | Select [Slide:`slide`, Smooth:`smooth`] | Slide: `slide` | | NO | YES | Allows select type of animation (slide, smooth). | -| Animation Duration (ms):`animationDuration` | Number | 600 | Animation Duration Logic | YES | YES | Allows determinate duration for animation. | -| With Controls:`withControls` | Checkbox | `false` | Controls Visibility Logic | NO | YES | Allows determine if the control buttons should be visible. | -| With Indicators:`withIndicators` | Checkbox | `false` | Indicators Visibility Logic | NO | YES | Allows determine if the indicators should be visible. | +| Property | Type | Default Value | Logic | Data Binding | UI Setting | Description | +|---------------------------------------------|-----------------------------------------|---------------------------------------|-----------------------------|--------------|------------|---------------------------------------------------------------------------------------------------------------| +| Images Data:`imagesData` | JSON | [Defalut Value](#images-data-default) | Image Data Logic | YES | YES | Sets the data for the carousel. JSON object structure: `{"url": string, "title": string, "content": string }` | +| Height:`height` | Text | "400px" | Height Logic | YES | YES | Sets the height for images. | +| Width:`width` | Text | "700px" | Width Logic | YES | YES | Sets the width for images. | +| Autoplay Delay(ms):`autoplayDelay` | Number | 5000 | Autoplay Delay | YES | YES | Sets the delay in milliseconds(ms) for autoplay. | +| Animation Type:`animationType` | Select [Slide:`slide`, Smooth:`smooth`] | Slide: `slide` | | NO | YES | Sets the animation type (slide, smooth). | +| Animation Duration (ms):`animationDuration` | Number | 600 | Animation Duration Logic | YES | YES | Sets the duration for animation. | +| With Controls:`withControls` | Checkbox | `false` | Controls Visibility Logic | NO | YES | Sets the visibility for control buttons. | +| With Indicators:`withIndicators` | Checkbox | `false` | Indicators Visibility Logic | NO | YES | Sets the visibility for indicators. | | ## Events diff --git a/components/bl-carousel-component/example-images/carousel_component_1.png b/components/bl-carousel-component/example-images/carousel_component_1.png new file mode 100644 index 000000000..109c0ca90 Binary files /dev/null and b/components/bl-carousel-component/example-images/carousel_component_1.png differ diff --git a/components/bl-carousel-component/example-images/carousel_component_2.png b/components/bl-carousel-component/example-images/carousel_component_2.png new file mode 100644 index 000000000..60f49d8ec Binary files /dev/null and b/components/bl-carousel-component/example-images/carousel_component_2.png differ