Skip to content

Commit

Permalink
chore(Slide): adjust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mvidalgarcia committed Mar 5, 2024
1 parent aa55f45 commit 54fe70d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/orbit-components/src/utils/Slide/README.md
Expand Up @@ -7,7 +7,7 @@ If a slide animation for some collapsible content is needed, the `Slide` compone
The `Slide` component should wrap the content that collapse and expand.

```jsx
import { Slide } from "@kiwicom/orbit-components";
import Slide from "@kiwicom/orbit-components/lib/utils/Slide";

<Slide expanded={isExpanded} maxHeight={height}>
{collapsibleContent}
Expand All @@ -21,6 +21,6 @@ import { Slide } from "@kiwicom/orbit-components";
| transitionDuration | `string` | `"fast"` | Determines the duration of the animation. Can be `"slow"`, `"normal"` or `"fast`. |
| children | `React.Node` | | The expandable content that should be animated. |
| maxHeight | `number \| null` | | The maximum height the animation should take. Usually it is the height of the container. |
| expanded | `boolean` | `false` | Determines if the content is expanded of not. When changed to `true`, the animation occurs. |
| expanded | `boolean` | `false` | Determines if the content is expanded or not. When changed to `true`, the animation occurs. |
| id | `string` | | Sets the id for the wrapper component responsible for the animation. |
| ariaLabelledBy | `string` | | Sets the ariaLabelledBy for the wrapper component responsible for the animation. |

0 comments on commit 54fe70d

Please sign in to comment.