Skip to content

Commit bef2b9d

Browse files
johnleiderjohnleider
committed
docs: add missing pages and nav links
1 parent a69ba92 commit bef2b9d

File tree

8 files changed

+144
-29
lines changed

8 files changed

+144
-29
lines changed

‎apps/docs/src/pages/composables/forms/use-proxy-model.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
meta:
3+
title: useProxyModel
4+
description: Proxy model utilities for reactive data binding with selection contexts.
5+
keywords: proxy model, two-way binding, selection, reactive, Vue, composable
6+
features:
7+
category: Forms
8+
label: 'E: useProxyModel'
9+
github: /composables/useProxyModel/
10+
---
11+
12+
# useProxyModel
13+
14+
Proxy model utilities for reactive data binding with selection contexts, enabling two-way synchronization between models and selection state.
15+
16+
<DocsPageFeatures :frontmatter />
17+
18+
## Introduction
19+
20+
The `useProxyModel` composable will provide utilities for creating proxy models that synchronize with selection contexts for seamless two-way data binding in Vue applications.
21+
22+
Documentation coming soon.

‎apps/docs/src/pages/composables/index.md‎

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,34 @@ Reusable pieces of logic that can be shared across components, providing encapsu
88

99
| Name | Description |
1010
| - | - |
11-
| [useBreakpoints](/composables/use-breakpoints) | Responsive breakpoint detection for different screen sizes |
12-
| [createContext](/composables/use-context) | Create reusable context to share state across components |
13-
| [useFilter](/composables/use-filter) | Filter arrays based on search queries |
14-
| [useGroup](/composables/use-group) | Manage collections with selection capabilities |
15-
| [useHydration](/composables/use-hydration) | Manage SSR hydration process |
16-
| [useKeydown](/composables/use-keydown) | Handle keyboard events with automatic cleanup |
17-
| [useLocale](/composables/use-locale) | Internationalization system for multiple languages |
18-
| [useMarkdown](/composables/use-markdown) | Render Markdown content in Vue applications |
19-
| [useRegistry](/composables/use-registry) | Foundation for registration-based systems |
20-
| [useSingle](/composables/use-single) | Simplified single-selection wrapper around useGroup |
21-
| [useStep](/composables/use-step) | Manage multi-step processes like forms or wizards |
22-
| [useStorage](/composables/use-storage) | Reactive interface to browser storage APIs |
23-
| [useTheme](/composables/use-theme) | Application theme management with CSS custom properties |
24-
| [useTokens](/composables/use-tokens) | Design token management system |
25-
| [useTrinity](/composables/use-trinity) | Standardized context pattern utility |
26-
| [useSingleton](/composables/use-singleton) | Extended trinity pattern with model binding |
27-
| [toReactive](/composables/to-reactive) | Convert refs to reactive objects
28-
| [useStorage](/composables/use-storage) | Persistent storage utilities for browser storage APIs with reactive state management. |
11+
| **Foundation** | |
12+
| [createContext](/composables/foundation/create-context) | Create reusable context to share state across components |
13+
| [createPlugin](/composables/foundation/create-plugin) | Create Vue plugins with standardized patterns |
14+
| [createTrinity](/composables/foundation/create-trinity) | Create context provider/consumer pattern utilities |
15+
| **Registration** | |
16+
| [useRegistry](/composables/registration/use-registry) | Foundation for registration-based systems |
17+
| [useTokens](/composables/registration/use-tokens) | Design token management system |
18+
| **Selection** | |
19+
| [useFilter](/composables/selection/use-filter) | Filter arrays based on search queries |
20+
| [useGroup](/composables/selection/use-group) | Manage collections with selection capabilities |
21+
| [useSelection](/composables/selection/use-selection) | General selection state management |
22+
| [useSingle](/composables/selection/use-single) | Simplified single-selection wrapper around useGroup |
23+
| [useStep](/composables/selection/use-step) | Manage multi-step processes like forms or wizards |
24+
| **Forms** | |
25+
| [useForm](/composables/forms/use-form) | Form state management and validation |
26+
| [useProxyModel](/composables/forms/use-proxy-model) | Proxy model utilities for reactive data binding |
27+
| **System** | |
28+
| [useEventListener](/composables/system/use-event-listener) | Handle DOM events with automatic cleanup |
29+
| [useIntersectionObserver](/composables/system/use-intersection-observer) | Intersection Observer API wrapper for visibility detection |
30+
| [useKeydown](/composables/system/use-keydown) | Handle keyboard events with automatic cleanup |
31+
| [useMutationObserver](/composables/system/use-mutation-observer) | Mutation Observer API wrapper for DOM change detection |
32+
| [useResizeObserver](/composables/system/use-resize-observer) | Resize Observer API wrapper for element size changes |
33+
| **Plugins** | |
34+
| [useBreakpoints](/composables/plugins/use-breakpoints) | Responsive breakpoint detection for different screen sizes |
35+
| [useFeatures](/composables/plugins/use-features) | Feature flags and A/B testing management |
36+
| [useHydration](/composables/plugins/use-hydration) | Manage SSR hydration process |
37+
| [useLocale](/composables/plugins/use-locale) | Internationalization system for multiple languages |
38+
| [useLogger](/composables/plugins/use-logger) | Logging system with multiple adapters |
39+
| [usePermissions](/composables/plugins/use-permissions) | Role-based access control and permissions management |
40+
| [useStorage](/composables/plugins/use-storage) | Reactive interface to browser storage APIs |
41+
| [useTheme](/composables/plugins/use-theme) | Application theme management with CSS custom properties |

‎apps/docs/src/pages/composables/system/use-intersection-observer.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
meta:
3+
title: useIntersectionObserver
4+
description: Intersection Observer API wrapper for detecting element visibility changes with automatic cleanup.
5+
keywords: intersection observer, visibility, viewport, lazy loading, scroll, Vue, composable
6+
features:
7+
category: System
8+
label: 'E: useIntersectionObserver'
9+
github: /composables/useIntersectionObserver/
10+
---
11+
12+
# useIntersectionObserver
13+
14+
A Vue composable wrapper for the Intersection Observer API that detects when elements enter or leave the viewport with automatic cleanup.
15+
16+
<DocsPageFeatures :frontmatter />
17+
18+
## Introduction
19+
20+
The `useIntersectionObserver` composable will provide a reactive interface to the Intersection Observer API for detecting element visibility in Vue applications.
21+
22+
Documentation coming soon.

‎apps/docs/src/pages/composables/system/use-mutation-observer.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
meta:
3+
title: useMutationObserver
4+
description: Mutation Observer API wrapper for watching DOM changes with automatic cleanup.
5+
keywords: mutation observer, DOM changes, attributes, children, Vue, composable
6+
features:
7+
category: System
8+
label: 'E: useMutationObserver'
9+
github: /composables/useMutationObserver/
10+
---
11+
12+
# useMutationObserver
13+
14+
A Vue composable wrapper for the Mutation Observer API that watches for changes to DOM elements with automatic cleanup.
15+
16+
<DocsPageFeatures :frontmatter />
17+
18+
## Introduction
19+
20+
The `useMutationObserver` composable will provide a reactive interface to the Mutation Observer API for detecting DOM changes in Vue applications.
21+
22+
Documentation coming soon.

‎apps/docs/src/pages/composables/system/use-resize-observer.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
meta:
3+
title: useResizeObserver
4+
description: Resize Observer API wrapper for detecting element size changes with automatic cleanup.
5+
keywords: resize observer, element size, responsive, dimensions, Vue, composable
6+
features:
7+
category: System
8+
label: 'E: useResizeObserver'
9+
github: /composables/useResizeObserver/
10+
---
11+
12+
# useResizeObserver
13+
14+
A Vue composable wrapper for the Resize Observer API that detects when element dimensions change with automatic cleanup.
15+
16+
<DocsPageFeatures :frontmatter />
17+
18+
## Introduction
19+
20+
The `useResizeObserver` composable will provide a reactive interface to the Resize Observer API for detecting element size changes in Vue applications.
21+
22+
Documentation coming soon.

‎apps/docs/src/pages/guide/composables.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎apps/docs/src/stores/app.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,21 +67,25 @@ export const useAppStore = defineStore('app', {
6767
name: 'Forms',
6868
children: [
6969
{ name: 'useForm', to: '/composables/forms/use-form' },
70+
{ name: 'useProxyModel', to: '/composables/forms/use-proxy-model' },
7071
],
7172
},
7273
{
7374
name: 'System',
7475
children: [
7576
{ name: 'useEventListener', to: '/composables/system/use-event-listener' },
77+
{ name: 'useIntersectionObserver', to: '/composables/system/use-intersection-observer' },
7678
{ name: 'useKeydown', to: '/composables/system/use-keydown' },
79+
{ name: 'useMutationObserver', to: '/composables/system/use-mutation-observer' },
80+
{ name: 'useResizeObserver', to: '/composables/system/use-resize-observer' },
7781
],
7882
},
7983
{
8084
name: 'Plugins',
8185
children: [
8286
{ name: 'useBreakpoints', to: '/composables/plugins/use-breakpoints' },
83-
{ name: 'useHydration', to: '/composables/plugins/use-hydration' },
8487
{ name: 'useFeatures', to: '/composables/plugins/use-features' },
88+
{ name: 'useHydration', to: '/composables/plugins/use-hydration' },
8589
{ name: 'useLocale', to: '/composables/plugins/use-locale' },
8690
{ name: 'useLogger', to: '/composables/plugins/use-logger' },
8791
{ name: 'usePermissions', to: '/composables/plugins/use-permissions' },

‎apps/docs/src/typed-router.d.ts‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ declare module 'vue-router/auto-routes' {
3030
'/components/theme': RouteRecordInfo<'/components/theme', '/components/theme', Record<never, never>, Record<never, never>>,
3131
'/composables/': RouteRecordInfo<'/composables/', '/composables', Record<never, never>, Record<never, never>>,
3232
'/composables/forms/use-form': RouteRecordInfo<'/composables/forms/use-form', '/composables/forms/use-form', Record<never, never>, Record<never, never>>,
33+
'/composables/forms/use-proxy-model': RouteRecordInfo<'/composables/forms/use-proxy-model', '/composables/forms/use-proxy-model', Record<never, never>, Record<never, never>>,
3334
'/composables/foundation/create-context': RouteRecordInfo<'/composables/foundation/create-context', '/composables/foundation/create-context', Record<never, never>, Record<never, never>>,
3435
'/composables/foundation/create-plugin': RouteRecordInfo<'/composables/foundation/create-plugin', '/composables/foundation/create-plugin', Record<never, never>, Record<never, never>>,
3536
'/composables/foundation/create-trinity': RouteRecordInfo<'/composables/foundation/create-trinity', '/composables/foundation/create-trinity', Record<never, never>, Record<never, never>>,
@@ -49,11 +50,13 @@ declare module 'vue-router/auto-routes' {
4950
'/composables/selection/use-single': RouteRecordInfo<'/composables/selection/use-single', '/composables/selection/use-single', Record<never, never>, Record<never, never>>,
5051
'/composables/selection/use-step': RouteRecordInfo<'/composables/selection/use-step', '/composables/selection/use-step', Record<never, never>, Record<never, never>>,
5152
'/composables/system/use-event-listener': RouteRecordInfo<'/composables/system/use-event-listener', '/composables/system/use-event-listener', Record<never, never>, Record<never, never>>,
53+
'/composables/system/use-intersection-observer': RouteRecordInfo<'/composables/system/use-intersection-observer', '/composables/system/use-intersection-observer', Record<never, never>, Record<never, never>>,
5254
'/composables/system/use-keydown': RouteRecordInfo<'/composables/system/use-keydown', '/composables/system/use-keydown', Record<never, never>, Record<never, never>>,
55+
'/composables/system/use-mutation-observer': RouteRecordInfo<'/composables/system/use-mutation-observer', '/composables/system/use-mutation-observer', Record<never, never>, Record<never, never>>,
56+
'/composables/system/use-resize-observer': RouteRecordInfo<'/composables/system/use-resize-observer', '/composables/system/use-resize-observer', Record<never, never>, Record<never, never>>,
5357
'/guide/': RouteRecordInfo<'/guide/', '/guide', Record<never, never>, Record<never, never>>,
5458
'/guide/accessibility': RouteRecordInfo<'/guide/accessibility', '/guide/accessibility', Record<never, never>, Record<never, never>>,
5559
'/guide/components': RouteRecordInfo<'/guide/components', '/guide/components', Record<never, never>, Record<never, never>>,
56-
'/guide/composables': RouteRecordInfo<'/guide/composables', '/guide/composables', Record<never, never>, Record<never, never>>,
5760
'/guide/features': RouteRecordInfo<'/guide/features', '/guide/features', Record<never, never>, Record<never, never>>,
5861
'/guide/framework-core': RouteRecordInfo<'/guide/framework-core', '/guide/framework-core', Record<never, never>, Record<never, never>>,
5962
'/guide/plugins': RouteRecordInfo<'/guide/plugins', '/guide/plugins', Record<never, never>, Record<never, never>>,
@@ -125,6 +128,10 @@ declare module 'vue-router/auto-routes' {
125128
routes: '/composables/forms/use-form'
126129
views: never
127130
}
131+
'src/pages/composables/forms/use-proxy-model.md': {
132+
routes: '/composables/forms/use-proxy-model'
133+
views: never
134+
}
128135
'src/pages/composables/foundation/create-context.md': {
129136
routes: '/composables/foundation/create-context'
130137
views: never
@@ -201,10 +208,22 @@ declare module 'vue-router/auto-routes' {
201208
routes: '/composables/system/use-event-listener'
202209
views: never
203210
}
211+
'src/pages/composables/system/use-intersection-observer.md': {
212+
routes: '/composables/system/use-intersection-observer'
213+
views: never
214+
}
204215
'src/pages/composables/system/use-keydown.md': {
205216
routes: '/composables/system/use-keydown'
206217
views: never
207218
}
219+
'src/pages/composables/system/use-mutation-observer.md': {
220+
routes: '/composables/system/use-mutation-observer'
221+
views: never
222+
}
223+
'src/pages/composables/system/use-resize-observer.md': {
224+
routes: '/composables/system/use-resize-observer'
225+
views: never
226+
}
208227
'src/pages/guide/index.md': {
209228
routes: '/guide/'
210229
views: never
@@ -217,10 +236,6 @@ declare module 'vue-router/auto-routes' {
217236
routes: '/guide/components'
218237
views: never
219238
}
220-
'src/pages/guide/composables.md': {
221-
routes: '/guide/composables'
222-
views: never
223-
}
224239
'src/pages/guide/features.md': {
225240
routes: '/guide/features'
226241
views: never

0 commit comments

Comments
 (0)