@flux-ui/internals 3.0.0-next.48 → 3.0.0-next.51

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.
Files changed (2) hide show
  1. package/README.md +25 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,20 @@
1
1
  # `@flux-ui/internals`
2
2
 
3
- Contains internals that are used in various `@flux-ui` packages.
3
+ Shared composables, utilities, directives, and data helpers used across the Flux UI packages.
4
+
5
+ Built with [`tsdown`](https://github.com/rolldown/tsdown).
6
+
7
+ ## Highlights
8
+
9
+ The package exposes four sub-entry points alongside the root export:
10
+
11
+ | Entry | Contents |
12
+ |-----------------------------|-------------------------------------------------------------------------------------|
13
+ | `@flux-ui/internals` | Re-exports of every entry below. |
14
+ | `@flux-ui/internals/composable` | `useCalendar`, `useEventListener`, `useFocusTrap`, `useFocusZone`, `useInView`, `useRemembered`, `useScrollEdges`, `useScrollPosition`, … |
15
+ | `@flux-ui/internals/data` | Data helpers — e.g. color utilities. |
16
+ | `@flux-ui/internals/directive` | Vue directives — `focusTrap`, `heightTransition`. |
17
+ | `@flux-ui/internals/util` | Focus helpers (`wrapFocus`, `getFocusableElement(s)`, `getKeyboardFocusableElements`, `getBidirectionalFocusElement`), `flattenVNodeTree`, `animationFrameDebounce`, `warn`, … |
4
18
 
5
19
  ## ⭐️ Prerequisites
6
20
 
@@ -9,6 +23,14 @@ Contains internals that are used in various `@flux-ui` packages.
9
23
 
10
24
  ## 🚀 Getting started
11
25
 
12
- 1. Make sure that the monorepo of Flux is used.
26
+ 1. Make sure the Flux monorepo is checked out.
13
27
  2. Run `bun install` in the project root.
14
- 3. Run `bun --cwd packages/internals build` to build the project.
28
+ 3. Run `bun run --cwd packages/internals build` to build the package.
29
+
30
+ ## 📦 Sibling packages
31
+
32
+ - [`@flux-ui/components`](../components)
33
+ - [`@flux-ui/types`](../types)
34
+ - [`@flux-ui/statistics`](../statistics)
35
+ - [`@flux-ui/dashboard`](../dashboard)
36
+ - [`@flux-ui/application`](../application)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@flux-ui/internals",
3
3
  "description": "Contains internal workings of Flux UI packages.",
4
- "version": "3.0.0-next.48",
4
+ "version": "3.0.0-next.51",
5
5
  "type": "module",
6
6
  "license": "MIT",
7
7
  "funding": "https://github.com/sponsors/basmilius",
@@ -61,7 +61,7 @@
61
61
  "dependencies": {
62
62
  "@basmilius/common": "^3.19.0",
63
63
  "@basmilius/utils": "^3.19.0",
64
- "@flux-ui/types": "3.0.0-next.48",
64
+ "@flux-ui/types": "3.0.0-next.51",
65
65
  "lodash-es": "^4.18.1",
66
66
  "luxon": "^3.7.2",
67
67
  "vue": "^3.6.0-beta.10"