Carousel Docs Review #439
Open
Carousel Docs Review #439
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
v-excelsior
reviewed
Apr 5, 2023
v-excelsior
suggested changes
Apr 5, 2023
|
|
||
| The component based on external [Carousel](https://getbootstrap.com/docs/5.2/components/carousel/). | ||
| <p align="center"> | ||
| <img src="./thumbnail.png" alt="main thumbnail" width="780"/> |
There was a problem hiding this comment.
Please remove ./example-images/carousel_component_1.png, component already have thumbnail
Comment on lines
+9
to
+13
| 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. | ||
|
|
||
| <p align="center"> | ||
| <img src="./example-images/carousel_component_2.png" alt="main thumbnail" width="780"/> | ||
| </p> |
There was a problem hiding this comment.
We already have JSON which could be copied and XML that needed for logic.
No need in image of JSON as it useless.
As for description. I believe approach where short and compressed documentation comes first and examples comes after it - is only one right solution for every level software engineers.
So we need to move that down(near already existed example with JSON)
For example Web Bible - MDN
Comment on lines
+15
to
+17
| You can also set images, titles and content by using the Codeless Logic presented below: | ||
|
|
||
|  |
There was a problem hiding this comment.
Is it just duplication of what we already have below?
There was a problem hiding this comment.
yes. It is there just to describe the context better.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.