arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-02-02 13:17:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(composables): clean

Browse Source
This commit is contained in:
Benjamin Canac
2024-09-30 14:33:07 +02:00
parent afd9b8f2b9
commit 10ab4ce06d
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/content/2.composables/use-modal.md
View File

@@ -21,7 +21,7 @@ Learn how to customize the appearance and behavior of modals in the **Modal** co
## API ## API
### `open(component: Component, props?: ModalProps & ComponentProps<T>): void` ### `open(component: Component, props?: ModalProps & ComponentProps<T>)`
Opens a modal with the specified component and props. Opens a modal with the specified component and props.
@@ -39,7 +39,7 @@ function openModal() {
</script> </script>
``` ```
### `close(): Promise<void>` ### `close()`
Closes the currently open modal. Closes the currently open modal.
@@ -53,7 +53,7 @@ async function closeModal() {
</script> </script>
``` ```
### `reset(): void` ### `reset()`
Resets the modal state to its default values. Resets the modal state to its default values.
@@ -67,7 +67,7 @@ function resetModal() {
</script> </script>
``` ```
### `patch(props: Partial<ModalProps & ComponentProps<T>>): void` ### `patch(props: Partial<ModalProps & ComponentProps<T>>)`
Updates the props of the currently open modal. Updates the props of the currently open modal.

6
docs/content/2.composables/use-slideover.md
View File

@@ -21,7 +21,7 @@ Learn how to customize the appearance and behavior of slideovers in the **Slideo
## API ## API
### `open(component: Component, props?: SlideoverProps & ComponentProps<T>): void` ### `open(component: Component, props?: SlideoverProps & ComponentProps<T>)`
Opens a slideover with the specified component and props. Opens a slideover with the specified component and props.
@@ -53,7 +53,7 @@ async function closeSlideover() {
</script> </script>
```` ````
### `reset(): void` ### `reset()`
Resets the slideover state to its default values. Resets the slideover state to its default values.
@@ -67,7 +67,7 @@ function resetSlideover() {
</script> </script>
```` ````
### `patch(props: Partial<SlideoverProps & ComponentProps<T>>): void` ### `patch(props: Partial<SlideoverProps & ComponentProps<T>>)`
Updates the props of the currently open slideover. Updates the props of the currently open slideover.