Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: create VSnackbarQueue component #19629

Merged
merged 7 commits into from
Apr 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/docs/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ declare module 'vue' {
AppSettingsPerksOptions: typeof import('./src/components/app/settings/PerksOptions.vue')['default']
AppSettingsSettingsHeader: typeof import('./src/components/app/settings/SettingsHeader.vue')['default']
AppSheet: typeof import('./src/components/app/Sheet.vue')['default']
AppSnackbarQueue: typeof import('./src/components/app/SnackbarQueue.vue')['default']
AppTable: typeof import('./src/components/app/Table.vue')['default']
AppTextField: typeof import('./src/components/app/TextField.vue')['default']
AppTitle: typeof import('./src/components/app/Title.vue')['default']
Expand Down
47 changes: 0 additions & 47 deletions packages/docs/src/components/app/SnackbarQueue.vue

This file was deleted.

4 changes: 4 additions & 0 deletions packages/docs/src/data/nav.json
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,10 @@
"title": "number-inputs",
"subfolder": "components"
},
{
"title": "snackbar-queue",
"subfolder": "components"
},
{
"title": "sparklines",
"subfolder": "components"
Expand Down
74 changes: 74 additions & 0 deletions packages/docs/src/examples/v-snackbar-queue/usage.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<template>
<ExamplesUsageExample
v-model="model"
:code="code"
:name="name"
:options="options"
>
<div>
<v-text-field
v-model="text"
label="Queue a message"
hide-details
@keydown.enter="onClick"
>
<template v-slot:append-inner>
<v-btn
:disabled="!text"
append-icon="mdi-arrow-right"
text="Queue"
flat
slim
@click="onClick"
></v-btn>
</template>
</v-text-field>

<v-snackbar-queue v-model="queue" :color="color" :timeout="timeout"></v-snackbar-queue>
</div>

<template v-slot:configuration>
<v-select
v-model="color"
:items="['primary', 'secondary', 'success', 'info', 'warning', 'error']"
label="Color"
clearable
></v-select>

<v-number-input v-model="timeout" min="-1"></v-number-input>
</template>
</ExamplesUsageExample>
</template>

<script setup>
const name = 'v-snackbar-queue'
const model = ref('default')
const options = []
const color = shallowRef()
const timeout = shallowRef(5000)
const queue = ref([])
const text = shallowRef('')

function onClick () {
queue.value.push({
text: text.value,
timeout: timeout.value,
color: color.value,
})
}

const props = computed(() => {
return {
color: color.value,
timeout: timeout.value !== 5000 ? timeout.value : undefined,
}
})

const slots = computed(() => {
return ''
})

const code = computed(() => {
return `<v-snackbar-queue${propsToString(props.value)}>${slots.value}</v-snackbar-queue>`
})
</script>
2 changes: 0 additions & 2 deletions packages/docs/src/layouts/default.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@

<AppBackToTop />

<AppSnackbarQueue />

<v-main>
<slot>
<v-container
Expand Down
2 changes: 0 additions & 2 deletions packages/docs/src/layouts/home.vue
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

<AppBarBar />

<AppSnackbarQueue />

<v-main class="text-center font-weight-light">
<router-view />
</v-main>
Expand Down
2 changes: 0 additions & 2 deletions packages/docs/src/layouts/user.vue
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@

<AppDrawerDrawer />

<AppSnackbarQueue />

<v-main>
<router-view v-slot="{ Component }">
<v-fade-transition hide-on-leave>
Expand Down
38 changes: 38 additions & 0 deletions packages/docs/src/pages/en/components/snackbar-queue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
emphasized: true
meta:
nav: Snackbar Queue
title: Snackbar Queue component
description: test
keywords: test
related:
- /components/buttons/
- /components/snackbars/
- /components/defaults-providers/
features:
github: /labs/VSnackbarQueue/
label: 'C: VSnackbarQueue'
report: true
spec: https://m2.material.io/components/snackbars
---

# Snackbar Queue

The `v-snackbar-queue` component is used to queue up multiple snackbar messages to be displayed to the user. Snackbars support positioning, removal delay, and callbacks.

<PageFeatures />

## Usage

<ExamplesUsage name="v-snackbar-queue" />

<PromotedEntry />

## API

| Component | Description |
| - | - |
| [v-snackbar-queue](/api/v-snackbar-queue/) | Primary Component |
| [v-snackbar](/api/v-snackbar/) | The actual Snackbar Component |

<ApiInline hide-links />
13 changes: 0 additions & 13 deletions packages/docs/src/stores/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ export type Category = {
color: string
}

export type Notification = {
message: string
timeout?: number
color?: string
}

export type RootState = {
apiSearch: string
drawer: boolean | null
Expand All @@ -21,7 +15,6 @@ export type RootState = {
items: NavItem[]
pages: string[]
settings: boolean
notifications: Notification[]
categories: Record<string, Category>
}

Expand All @@ -44,7 +37,6 @@ export const useAppStore = defineStore({
items: Array.from(data),
pages: getPages(data as NavItem[]),
settings: false,
notifications: [],
categories: {
api: {
icon: 'mdi-flask-outline',
Expand Down Expand Up @@ -92,11 +84,6 @@ export const useAppStore = defineStore({
},
},
} as RootState),
actions: {
snackbar (message: string, options: Partial<Notification> = {}) {
this.notifications.push({ message, ...options })
},
},
})

function getPage (item: NavItem, parent = ''): string[] {
Expand Down
Loading
Loading