ssovee-os-web-ui 0.1.4 → 0.1.6
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/README.md +6 -10
- package/dist/index.cjs +0 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.css +13 -0
- package/dist/index.css.map +1 -0
- package/dist/index.d.cts +1 -12
- package/dist/index.d.ts +1 -12
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -25,6 +25,8 @@ npm install react react-dom
|
|
|
25
25
|
|
|
26
26
|
This library uses Tailwind CSS. Install Tailwind CSS in the consuming application and follow the configuration below so Tailwind generates the library's classes.
|
|
27
27
|
|
|
28
|
+
The package entry is intended to provide the public React component surface. Internal helper hooks and utilities used by the components remain implementation details and are not part of the consumer-facing API.
|
|
29
|
+
|
|
28
30
|
## Tailwind CSS setup
|
|
29
31
|
|
|
30
32
|
Import the supplied base theme once from your application's global CSS file:
|
|
@@ -103,8 +105,8 @@ The library publishes the following shared UI components from the package entry
|
|
|
103
105
|
- `Typography`
|
|
104
106
|
- `ImageWithPlaceholder`
|
|
105
107
|
- `Table` and its table subcomponents
|
|
106
|
-
|
|
107
|
-
|
|
108
|
+
|
|
109
|
+
Internal helper hooks and utilities such as `useShortcutFormatter` and `cn` are used within the component implementation and are not documented as public package exports.
|
|
108
110
|
|
|
109
111
|
## Package structure
|
|
110
112
|
|
|
@@ -123,15 +125,9 @@ npm install
|
|
|
123
125
|
npm run build
|
|
124
126
|
```
|
|
125
127
|
|
|
126
|
-
##
|
|
128
|
+
## Internal component helpers
|
|
127
129
|
|
|
128
|
-
|
|
129
|
-
import { cn, useShortcutFormatter } from "ssovee-os-web-ui";
|
|
130
|
-
|
|
131
|
-
const { formatKeys } = useShortcutFormatter();
|
|
132
|
-
const className = cn("button", isActive && "button-active");
|
|
133
|
-
const shortcutLabel = formatKeys(["ctrl", "k"]);
|
|
134
|
-
```
|
|
130
|
+
The source tree contains helper hooks and utilities used only by the component implementation. These are internal implementation details and are not intended to be consumed directly via the library package entry.
|
|
135
131
|
|
|
136
132
|
## Versioning and release
|
|
137
133
|
|
package/dist/index.cjs
CHANGED
|
@@ -2021,7 +2021,5 @@ exports.Toast = Toast_default;
|
|
|
2021
2021
|
exports.Toggle = Toggle_default;
|
|
2022
2022
|
exports.Tooltip = Tooltip_default;
|
|
2023
2023
|
exports.Typography = Typography_default;
|
|
2024
|
-
exports.cn = cn;
|
|
2025
|
-
exports.useShortcutFormatter = useShortcutFormatter_default;
|
|
2026
2024
|
//# sourceMappingURL=index.cjs.map
|
|
2027
2025
|
//# sourceMappingURL=index.cjs.map
|