@nordmanai/nif 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,62 @@
-# Temporary Holding Version
+# @nordmanai/nif
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Nordman Interface Framework. One UI and UX system for every Nordman product.
+
+The order is fixed: **Base UI > shadcn > NIF**. Each component takes its behaviour and accessibility from a Base UI primitive, follows the shadcn composition, and is styled only by NIF tokens. Colour, spacing, radius, font size and icon size come from the Theming settings, so a product never hardcodes them.
+
+Docs and live examples: https://design.nordman.app
+
+## Install
+
+```bash
+npm install @nordmanai/nif @base-ui/react framer-motion lucide-react react react-dom
+```
+
+## Use
+
+Load the styles once, near the root of the app.
+
+```tsx
+import '@nordmanai/nif/styles.css';
+```
+
+Then import components.
+
+```tsx
+import { NmButton, NmDropdownMenu, NmDropdownMenuContent, NmDropdownMenuItem, NmDropdownMenuTrigger } from '@nordmanai/nif';
+import { nmButtonClassName } from '@nordmanai/nif';
+
+export function Example() {
+  return (
+    <>
+      <NmButton label="Save" tone="filled" icon="check" />
+      <NmDropdownMenu>
+        <NmDropdownMenuTrigger className={nmButtonClassName('outline')}>Open</NmDropdownMenuTrigger>
+        <NmDropdownMenuContent>
+          <NmDropdownMenuItem>Profile</NmDropdownMenuItem>
+        </NmDropdownMenuContent>
+      </NmDropdownMenu>
+    </>
+  );
+}
+```
+
+## Icons and marks
+
+Some components load icons and marks by URL from `/interface/`. Serve the package's `interface` folder at that path.
+
+```bash
+cp -r node_modules/@nordmanai/nif/interface public/interface
+```
+
+## Theming
+
+```tsx
+import { applyAppearanceState, createDefaultAppearanceState } from '@nordmanai/nif';
+
+applyAppearanceState({ ...createDefaultAppearanceState(), uiRadiusPercent: 120, uiSpacePercent: 110 });
+```
+
+## Source of truth
+
+NIF is authored in the Nordman web repo (`ui/` and `assets/tokens.css`). This package is built from that source. Never edit a copy in a product.

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+import './styles.css';
+export * from './ui/components/nm-accordion/nm-accordion.tsx';
+export * from './ui/components/nm-ai/nm-ai.tsx';
+export * from './ui/components/nm-avatar/nm-avatar.tsx';
+export * from './ui/components/nm-bar-overflow/nm-bar-overflow.tsx';
+export * from './ui/components/nm-bar-overflow/use-bar-overflow.ts';
+export * from './ui/components/nm-button/nm-button.tsx';
+export * from './ui/components/nm-chatbox/nm-chatbox-icon.tsx';
+export * from './ui/components/nm-chatbox/nm-chatbox.tsx';
+export * from './ui/components/nm-checkbox/nm-checkbox.tsx';
+export * from './ui/components/nm-collection/nm-collection-bar.tsx';
+export * from './ui/components/nm-collection/nm-collection-grid.tsx';
+export * from './ui/components/nm-collection/nm-collection-query.tsx';
+export * from './ui/components/nm-collection/nm-collection-row-menu.tsx';
+export * from './ui/components/nm-collection/nm-collection-table.tsx';
+export * from './ui/components/nm-collection/nm-collection-tile-actions.tsx';
+export * from './ui/components/nm-collection/nm-collection-title.tsx';
+export * from './ui/components/nm-collection/use-collection-scroll-reveal.ts';
+export * from './ui/components/nm-composer/nm-composer.tsx';
+export * from './ui/components/nm-dropdown/nm-dropdown-item.ts';
+export * from './ui/components/nm-dropdown/nm-dropdown-options.tsx';
+export * from './ui/components/nm-dropdown/nm-dropdown-panel.tsx';
+export * from './ui/components/nm-dropdown/nm-dropdown-placement.ts';
+export * from './ui/components/nm-dropdown/nm-dropdown.tsx';
+export * from './ui/components/nm-dropdown-menu/nm-dropdown-menu.tsx';
+export * from './ui/components/nm-field/nm-field.tsx';
+export * from './ui/components/nm-hover-card/nm-hover-card.tsx';
+export * from './ui/components/nm-icon/nm-icon.tsx';
+export * from './ui/components/nm-icon/nm-lucide.tsx';
+export * from './ui/components/nm-icon-border/nm-icon-border.tsx';
+export * from './ui/components/nm-list-item/nm-list-item.tsx';
+export * from './ui/components/nm-message/nm-message-actions.tsx';
+export * from './ui/components/nm-message/nm-message-meta.tsx';
+export * from './ui/components/nm-message/nm-text-shimmer.tsx';
+export * from './ui/components/nm-message/nm-trace.tsx';
+export * from './ui/components/nm-modal/nm-modal.tsx';
+export * from './ui/components/nm-panel-bar/nm-panel-bar.tsx';
+export * from './ui/components/nm-popover/nm-popover.tsx';
+export * from './ui/components/nm-progress/nm-progress.tsx';
+export * from './ui/components/nm-questionnaire/nm-questionnaire.tsx';
+export * from './ui/components/nm-radio-group/nm-radio-group.tsx';
+export * from './ui/components/nm-rail-icon/nm-rail-icon.tsx';
+export * from './ui/components/nm-segmented/nm-segmented.tsx';
+export * from './ui/components/nm-separator/nm-separator.tsx';
+export * from './ui/components/nm-slider/nm-slider.tsx';
+export * from './ui/components/nm-small-icon-button/nm-small-icon-button.tsx';
+export * from './ui/components/nm-switch/nm-switch.tsx';
+export * from './ui/components/nm-tabs/nm-tabs.tsx';
+export * from './ui/components/nm-toggle/nm-toggle.tsx';
+export * from './ui/components/nm-tooltip/nm-tooltip.tsx';
+export * from './ui/components/nm-top-bar/nm-top-bar.tsx';
+export * from './ui/components/nordman-icon-button/nordman-icon-button.tsx';
+export * from './ui/components/nordman-login/nordman-login.tsx';
+export * from './ui/components/nordman-login-field/nordman-login-field.tsx';
+export * from './ui/components/nordman-login-forgot/nordman-login-forgot.tsx';
+export * from './ui/components/nordman-login-google/nordman-login-google.tsx';
+export * from './ui/components/nordman-login-hero/nordman-login-hero.tsx';
+export * from './ui/components/nordman-login-register/nordman-login-register.tsx';
+export * from './ui/components/nordman-login-reset/nordman-login-reset.tsx';
+export * from './ui/components/nordman-login-reveal/nordman-login-reveal.tsx';
+export * from './ui/components/nordman-login-sign-in/nordman-login-sign-in.tsx';
+export * from './ui/components/nordman-toggle/nordman-toggle.tsx';
+export * from './ui/config/nm-ai.ts';
+export * from './ui/config/nm-app-panel.ts';
+export * from './ui/config/nm-appearance.ts';
+export * from './ui/config/nm-bar-overflow.ts';
+export * from './ui/config/nm-button.ts';
+export * from './ui/config/nm-chatbox-icons.ts';
+export * from './ui/config/nm-chatbox.ts';
+export * from './ui/config/nm-collection.ts';
+export * from './ui/config/nm-composer.ts';
+export * from './ui/config/nm-dropdown.ts';
+export * from './ui/config/nm-fade.ts';
+export * from './ui/config/nm-field.ts';
+export * from './ui/config/nm-header-icons.ts';
+export * from './ui/config/nm-icon-border.ts';
+export * from './ui/config/nm-icon-button.ts';
+export * from './ui/config/nm-icons.ts';
+export * from './ui/config/nm-list-item.ts';
+export * from './ui/config/nm-message.ts';
+export * from './ui/config/nm-modal.ts';
+export * from './ui/config/nm-panel-bar.ts';
+export * from './ui/config/nm-questionnaire.ts';
+export * from './ui/config/nm-radius.ts';
+export * from './ui/config/nm-rail-icons.ts';
+export * from './ui/config/nm-rail.ts';
+export * from './ui/config/nm-segmented.ts';
+export * from './ui/config/nm-site-palette.ts';
+export * from './ui/config/nm-small-icon-button.ts';
+export * from './ui/config/nm-tabs.ts';
+export * from './ui/config/nm-top-bar.ts';
+export * from './ui/config/nordman-chrome.ts';
+export * from './ui/config/nordman-login.ts';
+export * from './ui/lib/appearance/index.ts';
+export * from './ui/lib/nm-class.ts';