From 811e75db99acd5a36a7c69782255ae5af6c319b5 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Fri, 19 Nov 2021 17:11:50 +0100 Subject: [PATCH] docs: update --- README.md | 14 +++-- docs/app.vue | 2 +- docs/pages/index.vue | 131 ++++++++++++++++++++++++++----------------- 3 files changed, 90 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 0fca810d..8baf69ff 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,11 @@ import { defineNuxtConfig } from 'nuxt3' export default defineNuxtConfig({ buildModules: [ - ['@nuxthq/ui', { primary: 'blue' }] - ] + '@nuxthq/ui' + ], + ui: { + primary: 'blue' + } }) ``` @@ -59,7 +62,10 @@ import { defineNuxtConfig } from 'nuxt3' export default defineNuxtConfig({ buildModules: [ - ['@nuxthq/ui', { prefix: 'app' }] - ] + '@nuxthq/ui' + ], + ui: { + prefix: 'tw' + } }) ``` diff --git a/docs/app.vue b/docs/app.vue index fe4c230c..8b7b250b 100644 --- a/docs/app.vue +++ b/docs/app.vue @@ -17,7 +17,7 @@
  • -

    - Nuxt3 UI module documentation by NuxtLabs: -

    +
    +
    +

    + Documentation +

    +
    -
    - - toto - +

    + Components library as a Nuxt3 module using UnoCSS. +

    -
    - -
    +

    + Installation +

    -
    - - - - + 
    +      
+yarn add --dev @nuxthq/ui
+
    - -     -
    +

    Then, register the module in your `nuxt.config.js`:

    -
    - - Toggle modal! - + 
    +      
+import { defineNuxtConfig } from 'nuxt3'
 
-      
-        Body
-      
-
    +export default defineNuxtConfig({ + buildModules: [ + '@nuxthq/ui' + ] +}) + -
    - - - Open menu! - - -
    +

    If you want latest updates, please use `@nuxthq/ui-edge` in your `package.json`:

    -
    - - + 
    +      
+{
+  "devDependencies": {
+    "@nuxthq/ui": "npm:@nuxthq/ui-edge@latest"
+  }
+}
+
    - -     -
    +

    - `primary`

    -
    - -
    +

    Define the primary variant. Defaults to `indigo`. You can specify your own object of colors like here:

    - +

    + Example: +

    + + 
    +      
+import { defineNuxtConfig } from 'nuxt3'
+
+export default defineNuxtConfig({
+  buildModules: [
+    '@nuxthq/ui'
+  ],
+  ui: {
+    primary: 'blue'
+  }
+})
+
    + +

    - `prefix`

    + +

    Define the prefix of the imported components. Defaults to `u`.

    + +

    + Example: +

    + + 
    +      
+import { defineNuxtConfig } from 'nuxt3'
+
+export default defineNuxtConfig({
+  buildModules: [
+    '@nuxthq/ui'
+  ],
+  ui: {
+    prefix: 'tw'
+  }
+})
+