Skip to content

Commit

Permalink
docs(kslideout): documents prop settings
Browse files Browse the repository at this point in the history
Signed-off-by: Philipp Rudloff <philipp.rudloff@konghq.com>
  • Loading branch information
Philipp Rudloff committed Oct 16, 2023
1 parent bd7b891 commit 2b213e7
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/components/slideout.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,18 @@ Below we demonstrate wrapping `KSlideout` in the [`KToggle`](/components/renderl

### isVisible

* **Type**: `boolean`
* **Required**: no
* **Default**: `false`

Tells the component whether or not to render the open panel.

### closeButtonAlignment

* **Type**: `'start' | 'end'`
* **Required**: no
* **Default**: `'start'`

Controls the close button alignment, can be `start` (default) or `end`.

### offsetTop
Expand All @@ -76,6 +84,10 @@ Allows a host app to define the offset from the top of the page. If the value is

### hasOverlay

* **Type**: `boolean`
* **Required**: no
* **Default**: `true`

Tells the component whether or not to enable / disable overlay when the slideout content is visible, defaults to `true`.

<KToggle v-slot="{ isToggled, toggle }">
Expand Down Expand Up @@ -124,6 +136,10 @@ Tells the component whether or not to enable / disable overlay when the slideout

### preventCloseOnBlur

* **Type**: `boolean`
* **Required**: no
* **Default**: `false`

Persists the slideout, ignoring clicks outside of the panel. Defaults to `false`.

<KToggle v-slot="{ isToggled, toggle }">
Expand Down Expand Up @@ -156,6 +172,10 @@ Persists the slideout, ignoring clicks outside of the panel. Defaults to `false`

### title

* **Type**: `string`
* **Required**: no
* **Default**: `''`

This prop takes a string that will be displayed as the title of the slide-out.

<KToggle v-slot="{ isToggled, toggle }">
Expand Down

0 comments on commit 2b213e7

Please sign in to comment.