@juxtui/ui 0.5.0 → 0.7.0

package/README.md

@@ -1,63 +1,64 @@
-# juxt.ui
-
-**Thoughtfully crafted components for Nuxt & Vue.**
-
-juxt.ui is a small component library that cares about the details you feel but rarely notice: how far a menu travels when it opens, where focus goes when a dialog closes, whether a loading button changes width, what happens when you press Escape with a select open inside a dialog.
-
-It is Multiple components, one token system and one motion language. It's mostly grayscale, and the green `#079D6B` is kept for state.
-
-```vue
-<JButton>
-  Save changes
-</JButton>
-```
-
-## Installation
-
-```bash
-pnpm add @juxtui/ui
-```
-
-**Nuxt**: add the module. Components, composables and styles are wired up for you.
-
-```ts
-// nuxt.config.ts
-export default defineNuxtConfig({
-  modules: ['@juxtui/ui/nuxt'],
-})
-```
-
-**Vue**: import the stylesheet once, then import what you use.
-
-```ts
-import '@juxtui/ui/style.css'
-import { JButton, toast } from '@juxtui/ui'
-```
-
-Using Tailwind CSS v4? `@import '@juxtui/ui/tailwind.css'` maps the tokens onto utilities (`bg-surface`, `text-fg-muted`, `rounded-md`, `duration-fast`, …). juxt.ui's styles live in a `juxt` cascade layer, so your own classes always win.
-
-## Components
-
-| | |
-| --- | --- |
-| **Actions** | Button |
-| **Forms** | Input · Textarea · Checkbox · Switch · Select |
-| **Overlays** | Dialog · Dropdown Menu · Tooltip · Command Palette |
-| **Feedback** | Toast · Badge |
-| **Display** | Avatar · Card |
-| **Navigation** | Tabs |
-| **Layout** | Navbar · Burger · Footer · Sidebar |
-
-Each one supports light and dark themes, full keyboard use, reduced motion and SSR. Its docs page lists the keys it handles and the ARIA it exposes.
-
-## Design philosophy
-
-- **Quiet until it matters.** The interface is grayscale, and green marks state: focus, checked, success, where you are. Primary buttons use ink, not green.
-- **Motion is feedback.** There are four durations (80–240ms) and three curves, and only `transform` and `opacity` animate. Entrances are slower than exits. With reduced motion, things still fade but don't move.
-- **Accessible by construction.** Overlays trap focus, restore it when they close, and stack correctly: Escape and outside clicks go to the top-most layer only.
-- **Small APIs.** Props are named after what they do, and anything that holds state has a `v-model`. If you know one component, you know the rest.
-- **Tokens all the way down.** Colour, type, space, radius, elevation, motion and layering are CSS custom properties. Change `--juxt-accent` and the whole system follows.
-
-## License
-
-MIT
+# juxt.ui | https://juliuss3722.github.io/juxt-library/
+
+**Thoughtfully crafted components for Nuxt & Vue.**
+
+juxt.ui is a small component library that cares about the details you feel but rarely notice: how far a menu travels when it opens, where focus goes when a dialog closes, whether a loading button changes width, what happens when you press Escape with a select open inside a dialog.
+
+It is Multiple components, one token system and one motion language. It's mostly grayscale, and the green `#079D6B` is kept for state.
+
+```vue
+<JButton>
+  Save changes
+</JButton>
+```
+
+## Installation
+
+```bash
+pnpm add @juxtui/ui
+```
+
+**Nuxt**: add the module. Components, composables and styles are wired up for you.
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ['@juxtui/ui/nuxt'],
+})
+```
+
+**Vue**: import the stylesheet once, then import what you use.
+
+```ts
+import '@juxtui/ui/style.css'
+import { JButton, toast } from '@juxtui/ui'
+```
+
+Using Tailwind CSS v4? `@import '@juxtui/ui/tailwind.css'` maps the tokens onto utilities (`bg-surface`, `text-fg-muted`, `rounded-md`, `duration-fast`, …). juxt.ui's styles live in a `juxt` cascade layer, so your own classes always win.
+
+## Components
+
+| | |
+| --- | --- |
+| **Actions** | Button |
+| **Forms** | Input · Textarea · Checkbox · Switch · Select |
+| **Overlays** | Dialog · Dropdown Menu · Tooltip · Command Palette |
+| **Feedback** | Toast · Badge |
+| **Display** | Avatar · Card |
+| **Navigation** | Tabs |
+| **Layout** | Navbar · Burger · Footer · Sidebar |
+| **Editor** | Rich text editor with toolbar, selection menu, slash commands and Markdown shortcuts, from `@juxtui/ui/editor` |
+
+Each one supports light and dark themes, full keyboard use, reduced motion and SSR. Its docs page lists the keys it handles and the ARIA it exposes.
+
+## Design philosophy
+
+- **Quiet until it matters.** The interface is grayscale, and green marks state: focus, checked, success, where you are. Primary buttons use ink, not green.
+- **Motion is feedback.** There are four durations (80–240ms) and three curves, and only `transform` and `opacity` animate. Entrances are slower than exits. With reduced motion, things still fade but don't move.
+- **Accessible by construction.** Overlays trap focus, restore it when they close, and stack correctly: Escape and outside clicks go to the top-most layer only.
+- **Small APIs.** Props are named after what they do, and anything that holds state has a `v-model`. If you know one component, you know the rest.
+- **Tokens all the way down.** Colour, type, space, radius, elevation, motion and layering are CSS custom properties. Change `--juxt-accent` and the whole system follows.
+
+## License
+
+MIT