directix 1.5.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -29,6 +29,19 @@ Try it online with StackBlitz or CodeSandbox:
29
29
  | Vue 3 | [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/saqqdy/directix/tree/master/examples/vue3) | [![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/sandbox/github/saqqdy/directix/tree/master/examples/vue3) |
30
30
  | Vue 2 | [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/saqqdy/directix/tree/master/examples/vue2) | [![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/sandbox/github/saqqdy/directix/tree/master/examples/vue2) |
31
31
 
32
+ ## Playground
33
+
34
+ Try the interactive [Playground](https://saqqdy.github.io/directix/playground/) to configure directives and generate code:
35
+
36
+ - **57+ Directives** - Full coverage of all Directix directives
37
+ - **Vue 2 & Vue 3** - Generate code for either version
38
+ - **Composables** - Generate composable API code
39
+ - **TypeScript Ready** - Full type definitions included
40
+ - **Monaco Editor** - Full-featured code editor with syntax highlighting
41
+ - **Live Preview** - See directive effects in real-time
42
+
43
+ Each directive documentation page also includes a code generator for quick code snippets.
44
+
32
45
  ## Installation
33
46
 
34
47
  ```bash
@@ -128,6 +141,66 @@ const { run: debouncedSearch } = useDebounce({ handler: search, wait: 500 })
128
141
 
129
142
  See the [Composables](#composables) section below for all available composables.
130
143
 
144
+ ## Nuxt Integration
145
+
146
+ Directix provides a Nuxt module for seamless integration with Nuxt 3 applications.
147
+
148
+ ### Installation
149
+
150
+ The Nuxt module is included in the main package. Simply add it to your `nuxt.config.ts`:
151
+
152
+ ```typescript
153
+ // nuxt.config.ts
154
+ export default defineNuxtConfig({
155
+ modules: ['directix/nuxt'],
156
+
157
+ directix: {
158
+ // Enable/disable the module (default: true)
159
+ enabled: true,
160
+
161
+ // Only include specific directives (optional)
162
+ include: ['v-click-outside', 'v-copy', 'v-debounce'],
163
+
164
+ // Or exclude specific directives (optional)
165
+ exclude: ['v-ripple'],
166
+
167
+ // Default options for directives (optional)
168
+ directiveOptions: {
169
+ 'v-permission': {
170
+ config: {
171
+ getPermissions: () => ['read', 'write']
172
+ }
173
+ }
174
+ },
175
+
176
+ // Auto-import composables (default: true)
177
+ autoImportComposables: true
178
+ }
179
+ })
180
+ ```
181
+
182
+ ### Usage in Nuxt
183
+
184
+ Directives are automatically registered and composables are auto-imported:
185
+
186
+ ```vue
187
+ <template>
188
+ <div v-click-outside="handleClose">
189
+ <button v-copy="text">Copy</button>
190
+ </div>
191
+ </template>
192
+
193
+ <script setup>
194
+ // Composables are auto-imported, no need to import manually
195
+ const { copy, copied } = useCopy({ source: text })
196
+ const { isHovering } = useHover({ onEnter: handleEnter })
197
+ </script>
198
+ ```
199
+
200
+ ### SSR Compatibility
201
+
202
+ Directives that are not SSR-compatible will only run on the client side. The Nuxt module handles this automatically.
203
+
131
204
  ## Available Directives
132
205
 
133
206
  ### Event Directives
@@ -1714,6 +1787,51 @@ interface DirectiveInstallOptions {
1714
1787
 
1715
1788
  Each directive accepts different options. See the [documentation](https://github.com/saqqdy/directix#usage-examples) for detailed API.
1716
1789
 
1790
+ ## Roadmap
1791
+
1792
+ ### v1.7.0 (2026-04-15) - Visual Configuration Tool ✅
1793
+
1794
+ - **Online Playground** - Live editing environment with Vue 2/3 support
1795
+ - **Visual Configurator** - Interactive parameter configuration panel
1796
+ - **Code Generator** - Generate Vue 2/3/Composable/Nuxt code snippets
1797
+ - **Configuration Presets** - Quick-start templates for common use cases
1798
+ - **Monaco Editor** - CDN-loaded code editor with syntax highlighting
1799
+ - **Live Preview** - Real-time directive effect preview
1800
+
1801
+ ### v1.8.0 (Planned - 2026-04-22) - Quality & Ecosystem
1802
+
1803
+ - **Test Coverage** - 90%+ unit test coverage, E2E testing with Playwright
1804
+ - **Performance Optimization** - Bundle size optimization, tree-shaking improvements
1805
+ - **VS Code Extension** - Autocompletion, hover documentation, code snippets
1806
+ - **CLI Tool** - `directix create`, `directix init`, `directix doctor`, `directix migrate`
1807
+
1808
+ ### v1.9.0 (Planned - 2026-04-29) - Documentation & Community
1809
+
1810
+ - **Interactive Documentation** - Live editing with instant preview
1811
+ - **Real-world Examples** - 10+ practical scenario examples
1812
+ - **i18n Support** - English, Chinese, Japanese documentation
1813
+ - **Developer Experience** - Improved error messages, DevTools integration
1814
+ - **Plugin System** - Community extension support
1815
+
1816
+ ### v1.10.0 (Planned - 2026-05-06) - Vue 3 Optimization & Security
1817
+
1818
+ - **Vue 3 Optimization Preview** - Suspense, Teleport support
1819
+ - **Mobile Optimization** - Touch gestures, PWA support
1820
+ - **Accessibility (A11y)** - ARIA attributes, keyboard navigation
1821
+ - **Security Enhancements** - XSS protection, CSP compatibility
1822
+
1823
+ ### v1.11.0 (Planned - 2026-05-13) - Stability & Enterprise
1824
+
1825
+ - **Stability** - Browser compatibility, edge case fixes
1826
+ - **Performance Limits** - Bundle ≤ 25KB, memory optimization
1827
+ - **Enterprise Features** - Permissions, audit logs, config center
1828
+ - **v2.0 Migration Prep** - Migration tool, breaking changes warnings
1829
+
1830
+ ### v2.0.0 (Future)
1831
+
1832
+ - Vue 3 exclusive optimizations
1833
+ - Web Components support
1834
+
1717
1835
  ## Browser Support
1718
1836
 
1719
1837
  | Browser | Version |
package/dist/index.cjs CHANGED
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * directix v1.5.0
2
+ * directix v1.7.0
3
3
  * A comprehensive, easy-to-use, and high-performance Vue custom directives library supporting both Vue 2 and Vue 3
4
4
  * (c) 2021-present saqqdy <https://github.com/saqqdy>
5
5
  * Released under the MIT License.
@@ -78,7 +78,7 @@ var __async = (__this, __arguments, generator) => {
78
78
  });
79
79
  };
80
80
  /*!
81
- * directix v1.5.0
81
+ * directix v1.7.0
82
82
  * A comprehensive, easy-to-use, and high-performance Vue custom directives library supporting both Vue 2 and Vue 3
83
83
  * (c) 2021-present saqqdy <https://github.com/saqqdy>
84
84
  * Released under the MIT License.