📝 docs(message,button): update docs

This commit is contained in:
Timothy Yin 2024-11-22 22:16:28 +08:00
parent 222d2e8f1d
commit d9ad42dfa1
2 changed files with 79 additions and 0 deletions

View File

@ -43,6 +43,15 @@ props:
Button Button
:: ::
### Label
::ComponentPreview
---
props:
label: Button
---
::
### Disabled ### Disabled
::ComponentPreview ::ComponentPreview
@ -62,3 +71,8 @@ props:
--- ---
Button Button
:: ::
## Config
::ComponentDefaults
::

View File

@ -0,0 +1,65 @@
---
description: The message component is used to display a message to the user
---
## Usage
First add the `<RayMessages>` component to your `app.vue`.
```js
<template>
<NuxtLayout>
<NuxtPage />
</NuxtLayout>
<RayMessages />
</template>
```
Then, use the `useMessage` composable to add notifications to your app anywhere you want.
```vue
<script lang="ts" setup>
const message = useMessage()
const showMessage = () => {
message.add({
content: 'Hello RayineSoft',
type: 'success',
})
}
</script>
<template>
<RayButton label="Show Message" @click="showMessage" />
</template>
```
### Type
Multiple preset styles with icons and colors.
::ComponentPreview
---
props:
type: info
content: Hello RayineSoft
---
::
### Color
Use the `color` prop to change the color of the message.
::ComponentPreview
---
props:
color: amber
content: Hello RayineSoft
---
::
## Config
::ComponentDefaults
::