@atelier-ui/spec 0.0.1

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@atelier-ui/spec",
+  "version": "0.0.1",
+  "description": "Framework-agnostic TypeScript interfaces for the Atelier UI component API contract",
+  "keywords": [
+    "atelier-ui",
+    "typescript",
+    "spec",
+    "interfaces"
+  ],
+  "author": "Atelier UI",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DominikPieper/atelier-ui.git",
+    "directory": "libs/spec"
+  },
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "types": "./src/index.d.ts",
+  "main": "./src/index.js",
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,168 @@
+/**
+ * @atelier-ui/spec
+ *
+ * Framework-agnostic TypeScript interfaces defining the public API contract
+ * for every llm-components component. Both the Angular and React libraries
+ * import from here so the compiler enforces parity.
+ *
+ * Angular: use the union types as `input<T>()` type parameters.
+ * React: extend the spec interface from the framework-specific props interface.
+ */
+export type LlmButtonVariant = 'primary' | 'secondary' | 'outline';
+export type LlmButtonSize = 'sm' | 'md' | 'lg';
+export interface LlmButtonSpec {
+    variant?: LlmButtonVariant;
+    size?: LlmButtonSize;
+    disabled?: boolean;
+    loading?: boolean;
+}
+export type LlmBadgeVariant = 'default' | 'success' | 'warning' | 'danger' | 'info';
+export type LlmBadgeSize = 'sm' | 'md';
+export interface LlmBadgeSpec {
+    variant?: LlmBadgeVariant;
+    size?: LlmBadgeSize;
+}
+export type LlmAvatarSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+export type LlmAvatarShape = 'circle' | 'square';
+export type LlmAvatarStatus = 'online' | 'offline' | 'away' | 'busy' | '';
+export interface LlmAvatarSpec {
+    src?: string;
+    alt?: string;
+    name?: string;
+    size?: LlmAvatarSize;
+    shape?: LlmAvatarShape;
+    status?: LlmAvatarStatus;
+}
+export interface LlmAvatarGroupSpec {
+    max?: number;
+    size?: LlmAvatarSize;
+}
+export type LlmCardVariant = 'elevated' | 'outlined' | 'flat';
+export type LlmCardPadding = 'none' | 'sm' | 'md' | 'lg';
+export interface LlmCardSpec {
+    variant?: LlmCardVariant;
+    padding?: LlmCardPadding;
+}
+export interface LlmFormFieldSpec {
+    disabled?: boolean;
+    readonly?: boolean;
+    invalid?: boolean;
+    required?: boolean;
+    name?: string;
+}
+export type LlmInputType = 'text' | 'email' | 'password' | 'number' | 'tel' | 'url';
+export interface LlmInputSpec extends LlmFormFieldSpec {
+    type?: LlmInputType;
+    placeholder?: string;
+}
+export interface LlmTextareaSpec extends LlmFormFieldSpec {
+    rows?: number;
+    placeholder?: string;
+    autoResize?: boolean;
+}
+export interface LlmCheckboxSpec extends LlmFormFieldSpec {
+    checked?: boolean;
+    indeterminate?: boolean;
+}
+export interface LlmToggleSpec extends LlmFormFieldSpec {
+    checked?: boolean;
+}
+export interface LlmRadioSpec {
+    radioValue: string;
+    disabled?: boolean;
+}
+export interface LlmRadioGroupSpec extends LlmFormFieldSpec {
+    value?: string;
+}
+export interface LlmSelectSpec extends LlmFormFieldSpec {
+    placeholder?: string;
+}
+export interface LlmOptionSpec {
+    optionValue: string;
+    disabled?: boolean;
+}
+export type LlmAlertVariant = 'info' | 'success' | 'warning' | 'danger';
+export interface LlmAlertSpec {
+    variant?: LlmAlertVariant;
+    dismissible?: boolean;
+}
+export type LlmDialogSize = 'sm' | 'md' | 'lg' | 'xl' | 'full';
+export interface LlmDialogSpec {
+    open?: boolean;
+    closeOnBackdrop?: boolean;
+    size?: LlmDialogSize;
+}
+export type LlmTabGroupVariant = 'default' | 'pills';
+export interface LlmTabGroupSpec {
+    selectedIndex?: number;
+    variant?: LlmTabGroupVariant;
+}
+export interface LlmTabSpec {
+    label: string;
+    disabled?: boolean;
+}
+export type LlmAccordionGroupVariant = 'default' | 'bordered' | 'separated';
+export interface LlmAccordionGroupSpec {
+    multi?: boolean;
+    variant?: LlmAccordionGroupVariant;
+}
+export interface LlmAccordionItemSpec {
+    expanded?: boolean;
+    disabled?: boolean;
+}
+export type LlmMenuVariant = 'default' | 'compact';
+export interface LlmMenuSpec {
+    variant?: LlmMenuVariant;
+}
+export interface LlmMenuItemSpec {
+    disabled?: boolean;
+}
+export type LlmTooltipPosition = 'above' | 'below' | 'left' | 'right';
+export interface LlmTooltipSpec {
+    llmTooltip: string;
+    llmTooltipPosition?: LlmTooltipPosition;
+    llmTooltipDisabled?: boolean;
+    llmTooltipShowDelay?: number;
+    llmTooltipHideDelay?: number;
+}
+export type LlmToastVariant = 'default' | 'success' | 'warning' | 'danger' | 'info';
+export type LlmToastContainerPosition = 'top-right' | 'top-center' | 'bottom-right' | 'bottom-center';
+export interface LlmToastOptions {
+    variant?: LlmToastVariant;
+    duration?: number;
+    dismissible?: boolean;
+}
+export type LlmSkeletonVariant = 'text' | 'circular' | 'rectangular';
+export interface LlmSkeletonSpec {
+    variant?: LlmSkeletonVariant;
+    width?: string;
+    height?: string;
+    animated?: boolean;
+}
+export interface LlmBreadcrumbItemSpec {
+    href?: string;
+    current?: boolean;
+}
+export interface LlmPaginationSpec {
+    page?: number;
+    pageCount?: number;
+    siblingCount?: number;
+    showFirstLast?: boolean;
+}
+export type LlmProgressVariant = 'default' | 'success' | 'warning' | 'danger';
+export type LlmProgressSize = 'sm' | 'md' | 'lg';
+export interface LlmProgressSpec {
+    value?: number;
+    max?: number;
+    variant?: LlmProgressVariant;
+    size?: LlmProgressSize;
+    indeterminate?: boolean;
+}
+export type LlmDrawerPosition = 'left' | 'right' | 'top' | 'bottom';
+export type LlmDrawerSize = 'sm' | 'md' | 'lg' | 'full';
+export interface LlmDrawerSpec {
+    open?: boolean;
+    position?: LlmDrawerPosition;
+    size?: LlmDrawerSize;
+    closeOnBackdrop?: boolean;
+}

package/src/index.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * @atelier-ui/spec
+ *
+ * Framework-agnostic TypeScript interfaces defining the public API contract
+ * for every llm-components component. Both the Angular and React libraries
+ * import from here so the compiler enforces parity.
+ *
+ * Angular: use the union types as `input<T>()` type parameters.
+ * React: extend the spec interface from the framework-specific props interface.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/spec/src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG"}