@antify/ui-module 1.7.2 → 1.8.0

package/README.md

@@ -1,74 +1,65 @@
 # Ui module
 
-The antify ui module is a nuxt component library for applications based on tailwindcss.
+Nuxt integration for @antify/ui package.
 
-Compared to other component libraries, antify ui ships a fixed defined ux.
-It also provides a set of helper functions to easly implement that ux.
+# Installation
 
-The predefined ux defines, for example, what should happen if a requested 
-entry is not found.
+Install package
 
-The ux definitions you can find in the repo's wiki.
-
-# Development
-
-- Run `pnpm run dev:prepare` to generate type stubs.
-- Use `pnpm run dev` to start [playground](playground) in development mode.
-
-# Storybook
-## Start
 ```
-pnpm storybook
+pnpm i @antify/ui-module
 ```
 
-## Build
-```
-pnpm build-storybook
-```
+Add it to your nuxt.config.ts
 
-## Update Chromatic Build
+```ts
+defineNuxtConfig({
+  modules: [
+    '@antify/ui-module'
+  ]
+})
 ```
-pnpm chromatic
+
+# Usage
+
+Do not install the `@antify/ui` package or use imports directly from it.
+This module expose all components, types and helper form ui package through #ui-module
+virtual alias.
+
+It also expose all components to vue globally. You have not to import them in your components.
+
+```vue
+<script lang="ts" setup>
+  import {InputState} from '#ui-module';
+</script>
+
+<template>
+  <AntButton :state="InputState.info" />
+</template>
 ```
 
-## Useful links:
+# Plugins
 
-- Chromatic docu: https://www.chromatic.com/docs/
-- Storybook docu: https://storybook.js.org/docs/vue/get-started/introduction
+# Composables
 
-# Additional
 
-## SSR
-SSR is not included in the UX definition, because applications does not require SSR.
-To keep the UX as simple as possible, we decided to not support SSR.
 
-# Known issues
+# Development
+
+- Run `pnpm run dev:prepare` to generate type stubs.
+- Use `pnpm run dev` to start [playground](playground) in development mode.
 
-## Using this module as pnpm linked dependency
+# Additional
 
-Pnpm link does not work for local development, because the tailwindcss module can not 
-get installed outside of this project. An error "Cannot find module 'tailwindcss'" will be thrown.
+## SSR
 
-Use file link instead: 
-```
-"peerDependecies": {
-  "@antify/ui-module": "file:../ui-module"
-}
-```
+SSR is not included in the UX definition, because applications does not require SSR.
+To keep the UX as simple as possible, we decided to not support SSR.
 
-Keep in mind to reinstall the module after every change.
+Therefore, make sure you disabled ssr in your nuxt config.
 
-Also add the following to your `nuxt.config.ts`:
-```
-/**
- * Allow using packages outside the project dir with "link:../../example-package".
- * Without strict, vite would throw 403 error.
- */
-vite: {
-  server: {
-    fs: {
-      strict: false,
-    }
-  }
-}
+```ts
+defineNuxtConfig({
+  ssr: false
+})
 ```

package/dist/module.d.mts

@@ -1,264 +1,6 @@
 import { NuxtModule } from 'nuxt/schema';
-import { IconDefinition } from '@fortawesome/free-solid-svg-icons';
-import { RouteLocationRaw } from 'vue-router';
-
-declare enum Direction {
-    column = "column",
-    row = "row"
-}
-
-declare enum Grouped {
-    none = "none",
-    left = "left",
-    center = "center",
-    right = "right"
-}
-
-declare enum Position {
-    top = "top",
-    right = "right",
-    bottom = "bottom",
-    left = "left"
-}
-declare enum CornerPosition {
-    topLeft = "topLeft",
-    topRight = "topRight",
-    bottomRight = "bottomRight",
-    bottomLeft = "bottomLeft"
-}
-
-declare enum Size {
-    lg = "lg",
-    md = "md",
-    sm = "sm",
-    xs = "xs",
-    xs2 = "2xs"
-}
-
-declare enum State {
-    base = "base",
-    primary = "primary",
-    secondary = "secondary",
-    danger = "danger",
-    info = "info",
-    success = "success",
-    warning = "warning"
-}
-declare enum InputState {
-    base = "base",
-    danger = "danger",
-    info = "info",
-    success = "success",
-    warning = "warning"
-}
-
-declare enum CollapseStrategy {
-    single = "single",
-    multiple = "multiple"
-}
-
-declare enum IconSize {
-    xl3 = "3xl",
-    lg = "lg",
-    md = "md",
-    sm = "sm",
-    xs = "xs",
-    xs2 = "2xs"
-}
-
-declare enum AntKeycapSize {
-    sm = "sm",
-    xs = "xs"
-}
-
-declare enum ListGroupItemState {
-    base = "base",
-    primary = "primary",
-    secondary = "secondary",
-    info = "info",
-    success = "success",
-    warning = "warning",
-    danger = "danger"
-}
-
-declare enum AntSpinnerSize {
-    xl4 = "4xl",
-    xl3 = "3xl",
-    xl2 = "2xl",
-    lg = "lg",
-    md = "md",
-    sm = "sm",
-    xs = "xs",
-    xs2 = "2xs"
-}
-
-declare enum TagState {
-    base = "base",
-    primary = "primary",
-    secondary = "secondary",
-    info = "info",
-    success = "success",
-    warning = "warning",
-    danger = "danger"
-}
-declare enum AntTagSize {
-    lg = "lg",
-    md = "md",
-    sm = "sm",
-    xs = "xs",
-    xs2 = "2xs",
-    xs3 = "3xs"
-}
-
-type Toast = {
-    id?: string;
-    title: string;
-    content?: string;
-    type: InputState;
-    hasIcon?: boolean;
-};
-
-declare enum ButtonType {
-    button = "button",
-    submit = "submit"
-}
-
-type AntCheckboxType = {
-    label: string;
-    value: string;
-    disabled?: boolean;
-    readonly?: boolean;
-};
-declare enum AntCheckboxSize {
-    md = "md",
-    sm = "sm"
-}
-
-declare enum AntDateInputTypes {
-    date = "date",
-    datetimeLocal = "datetime-local",
-    month = "month",
-    time = "time",
-    week = "week"
-}
-
-declare enum AntRadioSize {
-    md = "md",
-    sm = "sm"
-}
-type AntRadioTypes = {
-    value: string;
-    label?: string;
-    disabled?: boolean;
-    readonly?: boolean;
-    state?: InputState;
-    [key: string]: unknown;
-};
-
-type SelectOption = {
-    label: string;
-    value: string | number;
-};
-
-type SwitcherOption = {
-    label: string;
-    value: string | number;
-};
-
-declare enum AntTagInputSize {
-    lg = "lg",
-    md = "md",
-    sm = "sm"
-}
-
-declare enum TextInputType {
-    email = "email",
-    tel = "tel",
-    text = "text",
-    url = "url"
-}
-
-declare enum BaseInputType {
-    date = "date",
-    datetime = "datetime",
-    datetimeLocal = "datetime-local",
-    email = "email",
-    hidden = "hidden",
-    month = "month",
-    number = "number",
-    password = "password",
-    search = "search",
-    tel = "tel",
-    text = "text",
-    time = "time",
-    url = "url",
-    week = "week",
-    range = "range"
-}
-
-type NavbarItemTypes = {
-    label: string;
-    active?: boolean;
-    to?: RouteLocationRaw;
-    click?: () => void;
-    icon?: IconDefinition;
-    children?: NavbarItemTypes[];
-};
-
-declare enum AntTableRowTypes {
-    text = "text",
-    html = "html",
-    link = "link",
-    slot = "slot"
-}
-declare enum AntTableAlign {
-    left = "left",
-    center = "center",
-    right = "right"
-}
-declare enum AntTableSortDirection {
-    asc = "asc",
-    desc = "desc",
-    neutral = "neutral"
-}
-type TableHeader = {
-    identifier: string;
-    title?: string;
-    type: AntTableRowTypes;
-    sortable?: boolean;
-    sort?: (a: unknown, b: unknown, direction: AntTableSortDirection) => number;
-    headerClassList?: string;
-    rowClassList?: string;
-    align?: AntTableAlign;
-    toProp?: string;
-    /**
-     * Emit if the column should be shown on light table version.
-     */
-    lightVersion?: boolean;
-};
-declare enum AntTableSize {
-    lg = "lg",
-    md = "md",
-    sm = "sm"
-}
-
-type TabItem = {
-    id: string;
-    label: string;
-    state?: TabItemState;
-    showIcon?: boolean;
-    icon?: IconDefinition;
-    to?: string | RouteLocationRaw;
-    clickHandler?: () => void;
-    [key: string]: unknown;
-};
-declare enum TabItemState {
-    base = "base",
-    warning = "warning",
-    danger = "danger"
-}
 
 type ModuleOptions = {};
 declare const module: NuxtModule<ModuleOptions>;
 
-export { AntCheckboxSize, type AntCheckboxType, AntDateInputTypes, AntKeycapSize, AntRadioSize, type AntRadioTypes, AntSpinnerSize, AntTableAlign, AntTableRowTypes, AntTableSize, AntTableSortDirection, AntTagInputSize, AntTagSize, BaseInputType, ButtonType, CollapseStrategy, CornerPosition, Direction, Grouped, IconSize, InputState, ListGroupItemState, type NavbarItemTypes, Position, type SelectOption, Size, State, type SwitcherOption, type TabItem, TabItemState, type TableHeader, TagState, TextInputType, type Toast, module as default };
+export { module as default };

package/dist/module.d.ts

@@ -1,264 +1,6 @@
 import { NuxtModule } from 'nuxt/schema';
-import { IconDefinition } from '@fortawesome/free-solid-svg-icons';
-import { RouteLocationRaw } from 'vue-router';
-
-declare enum Direction {
-    column = "column",
-    row = "row"
-}
-
-declare enum Grouped {
-    none = "none",
-    left = "left",
-    center = "center",
-    right = "right"
-}
-
-declare enum Position {
-    top = "top",
-    right = "right",
-    bottom = "bottom",
-    left = "left"
-}
-declare enum CornerPosition {
-    topLeft = "topLeft",
-    topRight = "topRight",
-    bottomRight = "bottomRight",
-    bottomLeft = "bottomLeft"
-}
-
-declare enum Size {
-    lg = "lg",
-    md = "md",
-    sm = "sm",
-    xs = "xs",
-    xs2 = "2xs"
-}
-
-declare enum State {
-    base = "base",
-    primary = "primary",
-    secondary = "secondary",
-    danger = "danger",
-    info = "info",
-    success = "success",
-    warning = "warning"
-}
-declare enum InputState {
-    base = "base",
-    danger = "danger",
-    info = "info",
-    success = "success",
-    warning = "warning"
-}
-
-declare enum CollapseStrategy {
-    single = "single",
-    multiple = "multiple"
-}
-
-declare enum IconSize {
-    xl3 = "3xl",
-    lg = "lg",
-    md = "md",
-    sm = "sm",
-    xs = "xs",
-    xs2 = "2xs"
-}
-
-declare enum AntKeycapSize {
-    sm = "sm",
-    xs = "xs"
-}
-
-declare enum ListGroupItemState {
-    base = "base",
-    primary = "primary",
-    secondary = "secondary",
-    info = "info",
-    success = "success",
-    warning = "warning",
-    danger = "danger"
-}
-
-declare enum AntSpinnerSize {
-    xl4 = "4xl",
-    xl3 = "3xl",
-    xl2 = "2xl",
-    lg = "lg",
-    md = "md",
-    sm = "sm",
-    xs = "xs",
-    xs2 = "2xs"
-}
-
-declare enum TagState {
-    base = "base",
-    primary = "primary",
-    secondary = "secondary",
-    info = "info",
-    success = "success",
-    warning = "warning",
-    danger = "danger"
-}
-declare enum AntTagSize {
-    lg = "lg",
-    md = "md",
-    sm = "sm",
-    xs = "xs",
-    xs2 = "2xs",
-    xs3 = "3xs"
-}
-
-type Toast = {
-    id?: string;
-    title: string;
-    content?: string;
-    type: InputState;
-    hasIcon?: boolean;
-};
-
-declare enum ButtonType {
-    button = "button",
-    submit = "submit"
-}
-
-type AntCheckboxType = {
-    label: string;
-    value: string;
-    disabled?: boolean;
-    readonly?: boolean;
-};
-declare enum AntCheckboxSize {
-    md = "md",
-    sm = "sm"
-}
-
-declare enum AntDateInputTypes {
-    date = "date",
-    datetimeLocal = "datetime-local",
-    month = "month",
-    time = "time",
-    week = "week"
-}
-
-declare enum AntRadioSize {
-    md = "md",
-    sm = "sm"
-}
-type AntRadioTypes = {
-    value: string;
-    label?: string;
-    disabled?: boolean;
-    readonly?: boolean;
-    state?: InputState;
-    [key: string]: unknown;
-};
-
-type SelectOption = {
-    label: string;
-    value: string | number;
-};
-
-type SwitcherOption = {
-    label: string;
-    value: string | number;
-};
-
-declare enum AntTagInputSize {
-    lg = "lg",
-    md = "md",
-    sm = "sm"
-}
-
-declare enum TextInputType {
-    email = "email",
-    tel = "tel",
-    text = "text",
-    url = "url"
-}
-
-declare enum BaseInputType {
-    date = "date",
-    datetime = "datetime",
-    datetimeLocal = "datetime-local",
-    email = "email",
-    hidden = "hidden",
-    month = "month",
-    number = "number",
-    password = "password",
-    search = "search",
-    tel = "tel",
-    text = "text",
-    time = "time",
-    url = "url",
-    week = "week",
-    range = "range"
-}
-
-type NavbarItemTypes = {
-    label: string;
-    active?: boolean;
-    to?: RouteLocationRaw;
-    click?: () => void;
-    icon?: IconDefinition;
-    children?: NavbarItemTypes[];
-};
-
-declare enum AntTableRowTypes {
-    text = "text",
-    html = "html",
-    link = "link",
-    slot = "slot"
-}
-declare enum AntTableAlign {
-    left = "left",
-    center = "center",
-    right = "right"
-}
-declare enum AntTableSortDirection {
-    asc = "asc",
-    desc = "desc",
-    neutral = "neutral"
-}
-type TableHeader = {
-    identifier: string;
-    title?: string;
-    type: AntTableRowTypes;
-    sortable?: boolean;
-    sort?: (a: unknown, b: unknown, direction: AntTableSortDirection) => number;
-    headerClassList?: string;
-    rowClassList?: string;
-    align?: AntTableAlign;
-    toProp?: string;
-    /**
-     * Emit if the column should be shown on light table version.
-     */
-    lightVersion?: boolean;
-};
-declare enum AntTableSize {
-    lg = "lg",
-    md = "md",
-    sm = "sm"
-}
-
-type TabItem = {
-    id: string;
-    label: string;
-    state?: TabItemState;
-    showIcon?: boolean;
-    icon?: IconDefinition;
-    to?: string | RouteLocationRaw;
-    clickHandler?: () => void;
-    [key: string]: unknown;
-};
-declare enum TabItemState {
-    base = "base",
-    warning = "warning",
-    danger = "danger"
-}
 
 type ModuleOptions = {};
 declare const module: NuxtModule<ModuleOptions>;
 
-export { AntCheckboxSize, type AntCheckboxType, AntDateInputTypes, AntKeycapSize, AntRadioSize, type AntRadioTypes, AntSpinnerSize, AntTableAlign, AntTableRowTypes, AntTableSize, AntTableSortDirection, AntTagInputSize, AntTagSize, BaseInputType, ButtonType, CollapseStrategy, CornerPosition, Direction, Grouped, IconSize, InputState, ListGroupItemState, type NavbarItemTypes, Position, type SelectOption, Size, State, type SwitcherOption, type TabItem, TabItemState, type TableHeader, TagState, TextInputType, type Toast, module as default };
+export { module as default };

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "ui-module",
   "configKey": "uiModule",
-  "version": "1.7.2"
+  "version": "1.8.0"
 }