@andesine/ui 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,19 @@
1
+ # Changelog
2
+
3
+ ## 0.4.0
4
+
5
+ First release. The version follows the other Andesine packages.
6
+
7
+ - Add the package structure and the `@andesine/ui/solid` export.
8
+ - Add `NavigationTree`, `TableOfContents`, `MobileNavigation`, `Breadcrumbs`, and
9
+ `Pagination`.
10
+ - Add `Tabs` with shared selection, and `createClipboard`.
11
+ - Add `createSearch` and `createListNavigation`.
12
+ - Add `createAnswer` for streamed answers with follow-ups and cancellation.
13
+ - Add `createPageActions` to copy the page link or its Markdown.
14
+ - Add `createSearchPalette`, `createPageScrollbar`, `createScrollEdges`,
15
+ `createScrollMemory`, `createTabIndicator`, `createTableOfContentsGuide`, and
16
+ the match helpers `splitMatches`, `matchesQuery`, and `getMatchPreview`.
17
+ - `NavigationTree` saves the expanded groups of each page, reads them before
18
+ hydration, and has `defaultDepth`. Its root has `data-storage-key`, which the
19
+ `@andesine/pages` restore script uses.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Vrite, Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # @andesine/ui
2
+
3
+ Headless documentation components for Andesine Pages. The components supply
4
+ structure, state, keyboard and focus behavior, and ARIA attributes. They supply
5
+ no styles.
6
+
7
+ > **Unstable.** The components follow the needs of the Andesine Pages template, and
8
+ > their API can change in any 0.x release. Pin the exact version.
9
+
10
+ ## Exports
11
+
12
+ | Export | Contents |
13
+ | -------------------- | -------------------- |
14
+ | `@andesine/ui/solid` | Solid.js components. |
15
+
16
+ ## Components
17
+
18
+ | Component | Behavior |
19
+ | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
20
+ | `NavigationTree` | Page links and groups. Link activation does not expand a group. Expanded groups persist in session storage, shared by trees with the same key. |
21
+ | `TableOfContents` | Heading links. Tracks the current heading and the headings in view, and moves focus after a click. |
22
+ | `MobileNavigation` | A `<details>` menu that is modal while open, and works without JavaScript. |
23
+ | `Breadcrumbs` | Ancestor links. |
24
+ | `Tabs` | Ark UI tabs. Tabs with the same `syncKey` share their selection. |
25
+ | `createClipboard` | Copies text and reports success or failure for a short time. |
26
+ | `createSearch` | Debounced search. A new query cancels the previous request, and only the latest response updates the results. |
27
+ | `createListNavigation` | Arrow, Home, End, and Enter keys for a list, e.g. from a combobox input. |
28
+ | `Pagination` | Previous and next links. |
29
+
30
+ The table of contents reads the document's `scroll-padding-top` as the height of
31
+ sticky headers.
32
+
33
+ Each component part renders `data-scope` and `data-part` attributes. State is in
34
+ `data-*` and ARIA attributes. Use these attributes to style the parts.
35
+
36
+ ## Build
37
+
38
+ ```sh
39
+ pnpm build --filter=@andesine/ui
40
+ ```
41
+
42
+ The Solid export has 4 conditions: `solid` (JSX source for Solid-aware bundlers),
43
+ `browser`, `node`, and `types`.