hs-uix 1.0.0 → 1.0.1

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 CHANGED
@@ -1,23 +1,21 @@
1
1
  # hs-uix
2
2
 
3
- [![@hs-uix/datatable](https://img.shields.io/npm/v/@hs-uix/datatable?label=%40hs-uix%2Fdatatable)](https://www.npmjs.com/package/@hs-uix/datatable)
4
- [![@hs-uix/form](https://img.shields.io/npm/v/@hs-uix/form?label=%40hs-uix%2Fform)](https://www.npmjs.com/package/@hs-uix/form)
5
- [![license](https://img.shields.io/npm/l/@hs-uix/datatable)](./LICENSE)
3
+ [![npm version](https://img.shields.io/npm/v/hs-uix)](https://www.npmjs.com/package/hs-uix)
4
+ [![license](https://img.shields.io/npm/l/hs-uix)](./LICENSE)
6
5
 
7
- Production-ready UI components for [HubSpot UI Extensions](https://developers.hubspot.com/docs/platform/ui-extensions-overview). Built entirely on HubSpot's native primitives — no custom HTML, no CSS, no iframes.
6
+ Production-ready UI components for [HubSpot UI Extensions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensions/overview). Built entirely on HubSpot's native primitives — no custom HTML, no CSS, no iframes.
8
7
 
9
- ## Packages
8
+ ## Components
10
9
 
11
- | Package | Version | Description |
12
- |---------|---------|-------------|
13
- | [`@hs-uix/datatable`](./packages/datatable) | [![npm](https://img.shields.io/npm/v/@hs-uix/datatable)](https://www.npmjs.com/package/@hs-uix/datatable) | Filterable, sortable, paginated DataTable with auto-sized columns, inline editing, row grouping, and more |
14
- | [`@hs-uix/form`](./packages/form) | [![npm](https://img.shields.io/npm/v/@hs-uix/form)](https://www.npmjs.com/package/@hs-uix/form) | Declarative, config-driven FormBuilder with validation, multi-step wizards, and 20+ field types |
10
+ | Component | Description | Docs |
11
+ |-----------|-------------|------|
12
+ | **DataTable** | Filterable, sortable, paginated table with auto-sized columns, inline editing, row grouping, and more | [Full documentation](./packages/datatable/README.md) |
13
+ | **FormBuilder** | Declarative, config-driven form with validation, multi-step wizards, and 20+ field types | [Full documentation](./packages/form/README.md) |
15
14
 
16
15
  ## Install
17
16
 
18
17
  ```bash
19
- npm install @hs-uix/datatable
20
- npm install @hs-uix/form
18
+ npm install hs-uix
21
19
  ```
22
20
 
23
21
  ## Quick Start
@@ -25,7 +23,7 @@ npm install @hs-uix/form
25
23
  ### DataTable
26
24
 
27
25
  ```jsx
28
- import { DataTable } from "@hs-uix/datatable";
26
+ import { DataTable } from "hs-uix/datatable";
29
27
 
30
28
  const columns = [
31
29
  { field: "name", label: "Name", sortable: true },
@@ -39,7 +37,7 @@ const columns = [
39
37
  ### FormBuilder
40
38
 
41
39
  ```jsx
42
- import { FormBuilder } from "@hs-uix/form";
40
+ import { FormBuilder } from "hs-uix/form";
43
41
 
44
42
  const fields = [
45
43
  { name: "email", label: "Email", type: "text", required: true },
@@ -52,13 +50,19 @@ const fields = [
52
50
  <FormBuilder fields={fields} onSubmit={(values) => console.log(values)} />;
53
51
  ```
54
52
 
53
+ You can also import everything from the root:
54
+
55
+ ```jsx
56
+ import { DataTable, FormBuilder } from "hs-uix";
57
+ ```
58
+
55
59
  ## Local Development
56
60
 
57
61
  ```bash
58
62
  # Install dependencies
59
63
  npm install
60
64
 
61
- # Build all packages
65
+ # Build
62
66
  npm run build
63
67
 
64
68
  # Watch mode
@@ -70,9 +74,10 @@ npm run dev
70
74
  ```
71
75
  hs-uix/
72
76
  ├── packages/
73
- │ ├── datatable/ ← @hs-uix/datatable
74
- │ └── form/ ← @hs-uix/form
75
- └── package.json npm workspaces root
77
+ │ ├── datatable/ ← DataTable source + docs
78
+ │ └── form/ ← FormBuilder source + docs
79
+ ├── src/ unified package entry points
80
+ └── package.json
76
81
  ```
77
82
 
78
83
  ## License