@octave-org/ui 0.0.2
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 +7 -0
- package/dist/README.md +48 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.esm.js +5099 -0
- package/dist/src/components.d.ts +8 -0
- package/dist/src/components.d.ts.map +1 -0
- package/dist/src/index.d.ts +8 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/lib/blocks/auth/authFormBuilder.d.ts +35 -0
- package/dist/src/lib/blocks/auth/authFormBuilder.d.ts.map +1 -0
- package/dist/src/lib/blocks/auth/index.d.ts +2 -0
- package/dist/src/lib/blocks/auth/index.d.ts.map +1 -0
- package/dist/src/lib/blocks/auth/wrapper.d.ts +6 -0
- package/dist/src/lib/blocks/auth/wrapper.d.ts.map +1 -0
- package/dist/src/lib/data-display/badge.d.ts +14 -0
- package/dist/src/lib/data-display/badge.d.ts.map +1 -0
- package/dist/src/lib/data-display/banner.d.ts +15 -0
- package/dist/src/lib/data-display/banner.d.ts.map +1 -0
- package/dist/src/lib/data-display/index.d.ts +5 -0
- package/dist/src/lib/data-display/index.d.ts.map +1 -0
- package/dist/src/lib/data-display/stat-card.d.ts +19 -0
- package/dist/src/lib/data-display/stat-card.d.ts.map +1 -0
- package/dist/src/lib/data-display/table.d.ts +26 -0
- package/dist/src/lib/data-display/table.d.ts.map +1 -0
- package/dist/src/lib/feedback/index.d.ts +2 -0
- package/dist/src/lib/feedback/index.d.ts.map +1 -0
- package/dist/src/lib/feedback/notifications.d.ts +12 -0
- package/dist/src/lib/feedback/notifications.d.ts.map +1 -0
- package/dist/src/lib/input-components/button.d.ts +17 -0
- package/dist/src/lib/input-components/button.d.ts.map +1 -0
- package/dist/src/lib/input-components/formBuilder.d.ts +26 -0
- package/dist/src/lib/input-components/formBuilder.d.ts.map +1 -0
- package/dist/src/lib/input-components/index.d.ts +4 -0
- package/dist/src/lib/input-components/index.d.ts.map +1 -0
- package/dist/src/lib/input-components/inputs.d.ts +12 -0
- package/dist/src/lib/input-components/inputs.d.ts.map +1 -0
- package/dist/src/lib/layout/index.d.ts +2 -0
- package/dist/src/lib/layout/index.d.ts.map +1 -0
- package/dist/src/lib/layout/nav-links.d.ts +14 -0
- package/dist/src/lib/layout/nav-links.d.ts.map +1 -0
- package/dist/src/lib/layout/shell.d.ts +24 -0
- package/dist/src/lib/layout/shell.d.ts.map +1 -0
- package/dist/src/lib/provider.d.ts +11 -0
- package/dist/src/lib/provider.d.ts.map +1 -0
- package/dist/src/lib/text/index.d.ts +2 -0
- package/dist/src/lib/text/index.d.ts.map +1 -0
- package/dist/src/lib/text/linkedText.d.ts +10 -0
- package/dist/src/lib/text/linkedText.d.ts.map +1 -0
- package/dist/src/lib/text/stackedText.d.ts +9 -0
- package/dist/src/lib/text/stackedText.d.ts.map +1 -0
- package/dist/src/lib/theme/index.d.ts +3 -0
- package/dist/src/lib/theme/index.d.ts.map +1 -0
- package/dist/src/lib/theme/theme.d.ts +142 -0
- package/dist/src/lib/theme/theme.d.ts.map +1 -0
- package/dist/src/lib/theme/themeTrigger.d.ts +2 -0
- package/dist/src/lib/theme/themeTrigger.d.ts.map +1 -0
- package/dist/src/utils/index.d.ts +4 -0
- package/dist/src/utils/index.d.ts.map +1 -0
- package/dist/src/utils/lib/cookies.d.ts +5 -0
- package/dist/src/utils/lib/cookies.d.ts.map +1 -0
- package/dist/src/utils/lib/formatters.d.ts +7 -0
- package/dist/src/utils/lib/formatters.d.ts.map +1 -0
- package/dist/src/utils/lib/media-queries.d.ts +6 -0
- package/dist/src/utils/lib/media-queries.d.ts.map +1 -0
- package/package.json +35 -0
package/README.md
ADDED
package/dist/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# OctaveOrg
|
|
2
|
+
|
|
3
|
+
This repository is focused on the **`@octave-org/ui`** package, which contains our core UI component library.
|
|
4
|
+
|
|
5
|
+
## Project Structure
|
|
6
|
+
|
|
7
|
+
- **`libs/ui`**: The primary UI component library. This is the main focus and deliverable of this project.
|
|
8
|
+
- **`apps/web`**: A Next.js application used purely as a test environment and sandbox for developing and showcasing the UI components.
|
|
9
|
+
|
|
10
|
+
## Getting Started
|
|
11
|
+
|
|
12
|
+
This repository uses [Nx](https://nx.dev) as its build system and [Bun](https://bun.sh) for package management.
|
|
13
|
+
|
|
14
|
+
### Install Dependencies
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
bun install
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### Working with the UI Package
|
|
21
|
+
|
|
22
|
+
To build the UI library:
|
|
23
|
+
|
|
24
|
+
```sh
|
|
25
|
+
bun nx build ui
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
To create a distributable tarball of the UI package:
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
cd libs/ui
|
|
32
|
+
bun pm pack
|
|
33
|
+
```
|
|
34
|
+
*(Note: Pushes to the `main` branch can also trigger a manual UI build workflow via GitHub Actions that publishes this tarball as an artifact).*
|
|
35
|
+
|
|
36
|
+
### Running the Test Web App
|
|
37
|
+
|
|
38
|
+
To run the development server for the test sandbox app:
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
bun nx dev web
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
To build the test app:
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
bun nx build web
|
|
48
|
+
```
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./src/index";
|