From 88b4ae94c7ef48bedac2e913131e6218eeb28da6 Mon Sep 17 00:00:00 2001 From: Warsono Date: Tue, 21 Mar 2023 17:15:12 +0700 Subject: [PATCH 1/2] fix(nuxt)!: change option name to `morpheme` BREAKING CHANGE: nuxt option renamed from `gitsUi` to `morpheme` --- docs/guide/nuxt.md | 18 +++++++++--------- packages/nuxt/playground/nuxt.config.ts | 2 +- packages/nuxt/src/module.ts | 20 ++++++++++---------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/guide/nuxt.md b/docs/guide/nuxt.md index a417308b3..c42311984 100644 --- a/docs/guide/nuxt.md +++ b/docs/guide/nuxt.md @@ -31,7 +31,7 @@ yarn add --dev sass ```ts export default defineNuxtConfig({ modules: ['@morpheme/ui-nuxt', '@nuxtjs/tailwindcss'], - gitsUi: { + morpheme: { // configuration options for Morpheme UI go here }, }); @@ -71,7 +71,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * css: true * }) */ @@ -83,7 +83,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * sass: true * }) */ @@ -95,7 +95,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * components: true * }) */ @@ -107,7 +107,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * transpileDeps: true * }) */ @@ -119,7 +119,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * loadFloatingVueStyles: true * }) */ @@ -132,7 +132,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * loadDefaultStyles: false * }) */ @@ -144,7 +144,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * darkMode: true * }) */ @@ -156,7 +156,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * optimizeDeps: true * }) */ diff --git a/packages/nuxt/playground/nuxt.config.ts b/packages/nuxt/playground/nuxt.config.ts index 222459367..d6536f194 100644 --- a/packages/nuxt/playground/nuxt.config.ts +++ b/packages/nuxt/playground/nuxt.config.ts @@ -2,7 +2,7 @@ import GitsUIModule from '..'; export default defineNuxtConfig({ modules: [GitsUIModule, '@nuxtjs/tailwindcss'], - gitsUi: { + morpheme: { darkMode: true, }, vite: { diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts index ea9b97bc7..0aa04b1e7 100644 --- a/packages/nuxt/src/module.ts +++ b/packages/nuxt/src/module.ts @@ -360,7 +360,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * css: true * }) */ @@ -372,7 +372,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * sass: true * }) */ @@ -384,7 +384,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * components: true * }) */ @@ -396,7 +396,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * transpileDeps: true * }) */ @@ -408,7 +408,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * loadFloatingVueStyles: true * }) */ @@ -421,7 +421,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * loadDefaultStyles: false * }) */ @@ -433,7 +433,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * darkMode: true * }) */ @@ -445,7 +445,7 @@ export interface ModuleOptions { * @example * // nuxt.config.ts * export default defineConfig({ - * gitsUi: { + * morpheme: { * optimizeDeps: true * }) */ @@ -454,8 +454,8 @@ export interface ModuleOptions { export default defineNuxtModule({ meta: { - name: 'gits-ui', - configKey: 'gitsUi', + name: 'morpheme', + configKey: 'morpheme', }, defaults: { css: false, From 56abb528faca348b20cb40c9eb6651e9a9cddf64 Mon Sep 17 00:00:00 2001 From: Warsono Date: Tue, 21 Mar 2023 17:17:51 +0700 Subject: [PATCH 2/2] docs(nuxt): add nuxt config example --- docs/guide/nuxt.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/guide/nuxt.md b/docs/guide/nuxt.md index c42311984..acbcd7549 100644 --- a/docs/guide/nuxt.md +++ b/docs/guide/nuxt.md @@ -179,6 +179,22 @@ defaults: { }, ``` +Config example: +```ts {8-11} +// https://nuxt.com/docs/api/configuration/nuxt-config +export default defineNuxtConfig({ + modules: [ + '@morpheme/nuxt', + '@nuxtjs/tailwindcss', + ], + // https://gitsindonesia.github.io/ui-component/guide/nuxt.html#options + morpheme: { + // enable dark mode + darkMode: true, + }, +}); +``` + ## Starter Checkout [starter](/guide/starter) page to quickly setup your project with Nuxt.js.