@antify/ui-module 1.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 antify
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# Ui module
+
+The antify ui module is a nuxt component library for applications based on tailwindcss.
+
+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.
+
+The predefined ux defines, for example, what should happen if a requested 
+entry is not found.
+
+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
+```
+
+## Build
+```
+pnpm build-storybook
+```
+
+## Update Chromatic Build
+```
+pnpm chromatic
+```
+
+## Useful links:
+
+- Chromatic docu: https://www.chromatic.com/docs/
+- Storybook docu: https://storybook.js.org/docs/vue/get-started/introduction
+
+# 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
+
+## Using this module as pnpm linked dependency
+
+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.
+
+Use file link instead: 
+```
+"peerDependecies": {
+  "@antify/ui-module": "file:../ui-module"
+}
+```
+
+Keep in mind to reinstall the module after every change.
+
+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,
+    }
+  }
+}
+```

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,131 @@
+import { NuxtModule } from 'nuxt/schema';
+
+declare enum ColorType {
+    base = "base",
+    primary = "primary",
+    secondary = "secondary",
+    danger = "danger",
+    info = "info",
+    success = "success",
+    warning = "warning"
+}
+declare enum InputColorType {
+    base = "base",
+    danger = "danger",
+    info = "info",
+    success = "success",
+    warning = "warning"
+}
+
+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 {
+    sm = "sm",
+    md = "md"
+}
+
+declare enum CollapseStrategy {
+    single = "single",
+    multiple = "multiple"
+}
+
+declare enum IconSize {
+    sm = "sm",
+    md = "md",
+    xl3 = "3xl"
+}
+
+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;
+};
+
+type SelectOption = {
+    label: string;
+    value: string | number;
+};
+
+type SwitcherOption = {
+    label: string;
+    value: string | number;
+};
+
+declare enum TextInputType {
+    email = "email",
+    password = "password",
+    tel = "tel",
+    text = "text",
+    url = "url"
+}
+
+declare enum ButtonType {
+    button = "button",
+    submit = "submit"
+}
+
+declare enum BaseInputType {
+    date = "date",
+    datetime = "datetime",
+    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 ModuleOptions = {};
+declare const module: NuxtModule<ModuleOptions>;
+
+export { AntTableAlign, AntTableRowTypes, AntTableSortDirection, BaseInputType, ButtonType, CollapseStrategy, ColorType, CornerPosition, Grouped, IconSize, InputColorType, Position, type SelectOption, Size, type SwitcherOption, type TableHeader, TextInputType, module as default };

package/dist/module.d.ts

@@ -0,0 +1,131 @@
+import { NuxtModule } from 'nuxt/schema';
+
+declare enum ColorType {
+    base = "base",
+    primary = "primary",
+    secondary = "secondary",
+    danger = "danger",
+    info = "info",
+    success = "success",
+    warning = "warning"
+}
+declare enum InputColorType {
+    base = "base",
+    danger = "danger",
+    info = "info",
+    success = "success",
+    warning = "warning"
+}
+
+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 {
+    sm = "sm",
+    md = "md"
+}
+
+declare enum CollapseStrategy {
+    single = "single",
+    multiple = "multiple"
+}
+
+declare enum IconSize {
+    sm = "sm",
+    md = "md",
+    xl3 = "3xl"
+}
+
+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;
+};
+
+type SelectOption = {
+    label: string;
+    value: string | number;
+};
+
+type SwitcherOption = {
+    label: string;
+    value: string | number;
+};
+
+declare enum TextInputType {
+    email = "email",
+    password = "password",
+    tel = "tel",
+    text = "text",
+    url = "url"
+}
+
+declare enum ButtonType {
+    button = "button",
+    submit = "submit"
+}
+
+declare enum BaseInputType {
+    date = "date",
+    datetime = "datetime",
+    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 ModuleOptions = {};
+declare const module: NuxtModule<ModuleOptions>;
+
+export { AntTableAlign, AntTableRowTypes, AntTableSortDirection, BaseInputType, ButtonType, CollapseStrategy, ColorType, CornerPosition, Grouped, IconSize, InputColorType, Position, type SelectOption, Size, type SwitcherOption, type TableHeader, TextInputType, module as default };

package/dist/module.json

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