duoop-ui 1.0.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/LICENSE +204 -0
- package/README.md +201 -0
- package/THIRD_PARTY_NOTICES.md +142 -0
- package/lib/index.js +6614 -0
- package/lib/styles.css +3817 -0
- package/package.json +79 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
203
|
+
|
|
204
|
+
Copyright 2026 Duoop-UI contributors
|
package/README.md
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="public/armadillo-logo.png" alt="Duoop UI armadillo" width="88" />
|
|
4
|
+
|
|
5
|
+
# Duoop UI
|
|
6
|
+
|
|
7
|
+
### Interfaces you can feel. Source code you can own.
|
|
8
|
+
|
|
9
|
+
Tactile React components with crisp outlines, playful motion, and satisfying feedback.
|
|
10
|
+
|
|
11
|
+
[**Explore the live catalog →**](https://duoop-ui.pages.dev/) · [Components](https://duoop-ui.pages.dev/?page=components) · [Installation](https://duoop-ui.pages.dev/?page=installation) · [Page examples](https://duoop-ui.pages.dev/?page=examples)
|
|
12
|
+
|
|
13
|
+
[](https://github.com/gus-rlin/Duoop-UI/actions/workflows/ci.yml)
|
|
14
|
+
[](LICENSE)
|
|
15
|
+
[](https://react.dev/)
|
|
16
|
+
|
|
17
|
+
</div>
|
|
18
|
+
|
|
19
|
+
[](https://duoop-ui.pages.dev/)
|
|
20
|
+
|
|
21
|
+
## Why Duoop?
|
|
22
|
+
|
|
23
|
+
- **A distinctive feel.** Raised surfaces, short shadows, expressive SVGs, and motion that responds to your actions.
|
|
24
|
+
- **Source included.** Preview, inspect, and copy complete JSX and CSS files, including local helpers.
|
|
25
|
+
- **Runnable downloads.** Download a Vite project with the displayed example, styles, and dependencies.
|
|
26
|
+
- **Plain React and CSS.** No Tailwind setup, custom CLI, or global provider required for a basic button.
|
|
27
|
+
- **Interaction matters.** Keyboard behavior, visible focus, reduced motion, and clear action feedback are part of the design.
|
|
28
|
+
|
|
29
|
+
This repository contains the documentation site and the installable React library, under Apache 2.0. Use the package to install the whole collection, or keep copying source files and downloading examples when you want to edit their implementation. Dedicated TypeScript declarations are not yet supplied.
|
|
30
|
+
|
|
31
|
+
## Install the library
|
|
32
|
+
|
|
33
|
+
The package is prepared in this repository; the first npm registry release is still pending. Until it is published, build an installable archive from a checkout:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
npm ci
|
|
37
|
+
npm pack
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
In your React 19 application, install the generated archive (adjust the path):
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
npm i /path/to/Duoop-UI/duoop-ui-1.0.0.tgz
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
After the first registry release, the equivalent command will be `npm i duoop-ui`. Both methods install the component dependencies automatically. React and React DOM are shared with your application as peer dependencies.
|
|
47
|
+
|
|
48
|
+
Import the stylesheet once in your application entry, then import components by name:
|
|
49
|
+
|
|
50
|
+
```jsx
|
|
51
|
+
import { Button, Card } from 'duoop-ui';
|
|
52
|
+
import 'duoop-ui/styles.css';
|
|
53
|
+
|
|
54
|
+
export default function App() {
|
|
55
|
+
return <Card><Button onClick={() => alert('Hello!')}>Press me</Button></Card>;
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
The ESM package contains all public components, their compound components and helpers, including `IconButton`. It excludes the catalogue, demos and development tools. Your bundler can remove unused JavaScript exports; the single stylesheet includes the full collection, the shared foundation and Leaflet styles. The foundation sets page defaults such as body margin and font, so import your application overrides afterwards. DM Sans remains an optional font installation.
|
|
60
|
+
|
|
61
|
+
Use a React bundler such as Vite. For Next.js, import the stylesheet in the root layout and use interactive components from a client component; the library entry preserves its `"use client"` boundary. Next.js integration and dedicated TypeScript declarations are not yet verified/provided. The source-copy instructions below remain available.
|
|
62
|
+
|
|
63
|
+
## Explore the collection
|
|
64
|
+
|
|
65
|
+
**46 components · 7 categories**, each with downloadable examples. The collection includes Breadcrumb and Separator, plus Tooltip, Popover, Slider, Calendar, Date Picker, Table, Pagination, Sheet, File Upload, Skeleton and Alert. See [integration notes and verification](docs/essential-components.md).
|
|
66
|
+
|
|
67
|
+
| Collection | Explore |
|
|
68
|
+
| --- | --- |
|
|
69
|
+
| Buttons | [Raised buttons and reactions](https://duoop-ui.pages.dev/?category=Buttons) |
|
|
70
|
+
| Forms | [Inputs, selection, and validation](https://duoop-ui.pages.dev/?category=Forms) |
|
|
71
|
+
| Navigation | [Menus and tabs](https://duoop-ui.pages.dev/?category=Navigation) |
|
|
72
|
+
| Cards | [Cards and composed layouts](https://duoop-ui.pages.dev/?category=Cards) |
|
|
73
|
+
| Feedback | [Toasts, progress, and achievements](https://duoop-ui.pages.dev/?category=Feedback) |
|
|
74
|
+
| Motion | [Animated text and expressive interactions](https://duoop-ui.pages.dev/?category=Motion) |
|
|
75
|
+
| Display | [Avatars, maps, and more](https://duoop-ui.pages.dev/?category=Display) |
|
|
76
|
+
|
|
77
|
+
Explore [Page examples](https://duoop-ui.pages.dev/?page=examples). Sources include a [studio landing page](src/examples/LandingPage.jsx) and a [settings page](src/examples/SettingsPage.jsx). Example brands, pricing, forms, and persistence are demonstrations; connect your own services when adapting them.
|
|
78
|
+
|
|
79
|
+
## Your first component by copying source
|
|
80
|
+
|
|
81
|
+
Use **React 19 + React DOM 19**, JSX compilation, and CSS imports. For a new Vite app, use Node.js **22.12+ or 24+**:
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
npm create vite@latest my-duoop-app -- --template react
|
|
85
|
+
cd my-duoop-app
|
|
86
|
+
npm install
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Open [Raised button → Code](https://duoop-ui.pages.dev/?component=builtin-relief-button&tab=code) and copy these files, preserving their paths:
|
|
90
|
+
|
|
91
|
+
| File | Purpose |
|
|
92
|
+
| --- | --- |
|
|
93
|
+
| [src/base.css](src/base.css) | Shared sizing, font fallback, accessible hidden text, and inset focus. |
|
|
94
|
+
| [src/components/Button/Button.jsx](src/components/Button/Button.jsx) | Button and ActionFeedback; imports its CSS and helper. |
|
|
95
|
+
| [src/components/Button/Button.css](src/components/Button/Button.css) | Appearance, depth, states, and reduced motion. |
|
|
96
|
+
| [src/components/Button/buttonColor.js](src/components/Button/buttonColor.js) | Custom color palette calculations. |
|
|
97
|
+
|
|
98
|
+
Or select **Download project**, unzip it, run `npm install`, then `npm run dev`. The download already includes the setup below.
|
|
99
|
+
|
|
100
|
+
Replace `src/main.jsx` with:
|
|
101
|
+
|
|
102
|
+
```jsx
|
|
103
|
+
import React from 'react';
|
|
104
|
+
import { createRoot } from 'react-dom/client';
|
|
105
|
+
import App from './App.jsx';
|
|
106
|
+
import './base.css';
|
|
107
|
+
|
|
108
|
+
createRoot(document.getElementById('root')).render(<App />);
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Keep Vite's `<div id="root"></div>` in `index.html`. Remove its template `index.css` and `App.css` imports to avoid conflicting layout rules. Do not copy the catalog's `src/styles.css` into your app.
|
|
112
|
+
|
|
113
|
+
Replace `src/App.jsx` with:
|
|
114
|
+
|
|
115
|
+
```jsx
|
|
116
|
+
import React, { useState } from 'react';
|
|
117
|
+
import { Button } from './components/Button/Button.jsx';
|
|
118
|
+
|
|
119
|
+
export default function App() {
|
|
120
|
+
const [count, setCount] = useState(0);
|
|
121
|
+
return (
|
|
122
|
+
<main style={{ padding: 32 }}>
|
|
123
|
+
<Button onClick={() => setCount(value => value + 1)}>
|
|
124
|
+
Pressed {count} times
|
|
125
|
+
</Button>
|
|
126
|
+
</main>
|
|
127
|
+
);
|
|
128
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Run `npm run dev`. Clicking increments the counter; Tab reveals inset focus and Enter/Space activate the button. `npm run build` creates `dist/`. Button needs no additional dependencies beyond React.
|
|
132
|
+
|
|
133
|
+
### Styling and integration
|
|
134
|
+
|
|
135
|
+
Import `base.css` once; components import their own styles. To match the site's **DM Sans** font, install and import `@fontsource-variable/dm-sans`, then set `:root { --duoop-font: 'DM Sans Variable', system-ui, sans-serif; }`. Otherwise, the foundation uses a system font.
|
|
136
|
+
|
|
137
|
+
| Feature | Integration |
|
|
138
|
+
| --- | --- |
|
|
139
|
+
| GSAP motion | Install `gsap` when listed in Installation. Preserve reduced-motion behavior; Text Loop includes an explicit pause in its minimal example. |
|
|
140
|
+
| Map | Install `leaflet`; preserve CSS and attribution. OSM/CARTO tiles need network access and remain subject to provider terms and capacity. |
|
|
141
|
+
| Toast | Wrap `useToast()` consumers in `ToastProvider` and render `ToastViewport` once. |
|
|
142
|
+
| Dialog, Select, Menu | Keep the positioning helpers and CSS listed in Installation. Overlays may use portals. |
|
|
143
|
+
| Images and async demos | Supply production images and connect authentication, server validation, requests, quotas, and persistence. |
|
|
144
|
+
| Next.js | Add a `'use client';` boundary above hook-based components; import the foundation in your layout. Map needs client-only loading without SSR. This framework integration is not separately verified. |
|
|
145
|
+
| TypeScript | Allow JavaScript with `allowJs: true`, or add types in your project. |
|
|
146
|
+
|
|
147
|
+
Page downloads map the page to `src/App.jsx` and [pages.css](src/examples/pages.css) to `src/example.css`, including the foundation and local dependencies. The settings example stores test data under `duoop-example-settings-v1`; replace `readSettings()` and `save()` with your API.
|
|
148
|
+
|
|
149
|
+
On Windows, if npm reports `UNABLE_TO_VERIFY_LEAF_SIGNATURE` and your network certificate is in the system store, use Node.js 24 and set `$env:NODE_USE_SYSTEM_CA = '1'` in PowerShell before installing. This preserves TLS verification.
|
|
150
|
+
|
|
151
|
+
## Develop and test
|
|
152
|
+
|
|
153
|
+
Catalog tooling requires **Node.js 22.18+ in the 22.x line, or 24.11+**, and npm.
|
|
154
|
+
|
|
155
|
+
```sh
|
|
156
|
+
git clone https://github.com/gus-rlin/Duoop-UI.git
|
|
157
|
+
cd Duoop-UI
|
|
158
|
+
npm ci
|
|
159
|
+
npm run dev
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
| Command | Purpose |
|
|
163
|
+
| --- | --- |
|
|
164
|
+
| `npm run build` | Build the static site into `dist/`. |
|
|
165
|
+
| `npm run build:lib` | Build the npm library into `lib/`. |
|
|
166
|
+
| `npm pack` | Build and create the installable `duoop-ui-1.0.0.tgz` archive. |
|
|
167
|
+
| `npm run test:package` | Install the archive in an isolated app; verify exports, build, styling and interaction. |
|
|
168
|
+
| `npm run preview` | Preview the production build. |
|
|
169
|
+
| `npm test` | Build, check imports, run public browser/SEO tests, and build downloaded projects. |
|
|
170
|
+
| `npm run test:primitives` | Run detailed primitive suites against a dev server on port 5176. |
|
|
171
|
+
| `npm run test:a11y` | Audit galleries against a dev server on port 5176. |
|
|
172
|
+
| `npm run test:pages` | Build and test downloaded pages after `npm test`. |
|
|
173
|
+
| `npm run test:integration` | Verify the README button in a fresh Vite app; requires npm access. |
|
|
174
|
+
|
|
175
|
+
Install Chromium with `npx playwright install chromium`. For a fixed dev port, run `npm run dev -- --port 5176 --strictPort`; `TEST_URL` overrides the primitive suites' server address. Reports and screenshots go to the ignored `artifacts/` directory.
|
|
176
|
+
|
|
177
|
+
GitHub CI runs the production build, import checks, and SEO browser tests. See [VALIDATION.md](VALIDATION.md) for historical results and known limitations. Automated accessibility checks are not a comprehensive certification.
|
|
178
|
+
|
|
179
|
+
## Deployment
|
|
180
|
+
|
|
181
|
+
### npm release
|
|
182
|
+
|
|
183
|
+
Run `npm run test:package` before releasing (Chromium must be installed). Review `npm pack --dry-run`, verify that you control the npm package name, and sign in with `npm login`. Set the release version with `npm version <version>`, then run `npm publish --access public`. The `prepack` hook rebuilds the library for packing and publishing. Registry publication is a separate maintainer action; this repository does not publish automatically. Once the first release is available, update the pending-release instructions here and on the Installation page.
|
|
184
|
+
|
|
185
|
+
### Documentation site
|
|
186
|
+
|
|
187
|
+
The live site is on [Cloudflare Pages](https://duoop-ui.pages.dev/). Deploy `dist/` over HTTPS for clipboard access. Query-based deep links do not need route rewrites. Preserve public TXT/XML files and allow required remote demo assets in any CSP. See [SEO.md](SEO.md).
|
|
188
|
+
|
|
189
|
+
Legacy personal entries in `duoop-ui.components.v1` are no longer displayed; their stored data is not deleted or rewritten.
|
|
190
|
+
|
|
191
|
+
## Contribute
|
|
192
|
+
|
|
193
|
+
Start with [CONTRIBUTING.md](CONTRIBUTING.md), follow the [design guidelines](design.md), and use the [issue templates](https://github.com/gus-rlin/Duoop-UI/issues/new/choose) for bugs and ideas.
|
|
194
|
+
|
|
195
|
+
Useful entry points: [catalog metadata](src/catalog/catalog.js), [integration recipes](src/catalog/recipes.js), [source bundling](src/catalog/source-bundle.js), and [code documentation](src/components/Button/Documentation.jsx).
|
|
196
|
+
|
|
197
|
+
If Duoop helps you build something, a GitHub star helps others discover it.
|
|
198
|
+
|
|
199
|
+
## License
|
|
200
|
+
|
|
201
|
+
[Apache License 2.0](LICENSE). Preserve required license and attribution notices. Third-party dependencies and demo assets retain their own terms.
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# Third-party component foundations
|
|
2
|
+
|
|
3
|
+
Duoop adapts the official composition examples and uses the unstyled runtime packages below. Duoop CSS, demos and integration are maintained in this repository. Dependency source is installed through npm, rather than vendored.
|
|
4
|
+
|
|
5
|
+
- Radix Primitives — Tooltip, Popover, Slider and Dialog (Sheet): https://github.com/radix-ui/primitives and https://www.radix-ui.com/primitives/docs/components
|
|
6
|
+
- React DayPicker v9 — Calendar and Date Picker: https://github.com/gpbl/react-day-picker and https://daypicker.dev/v9
|
|
7
|
+
- React Dropzone — file selection and validation: https://github.com/react-dropzone/react-dropzone
|
|
8
|
+
|
|
9
|
+
The following MIT notices are retained for these foundations and accompanying examples. Other transitive dependencies retain their own notices in their npm distributions.
|
|
10
|
+
|
|
11
|
+
## Radix Primitives
|
|
12
|
+
MIT License
|
|
13
|
+
|
|
14
|
+
Copyright (c) 2022 WorkOS
|
|
15
|
+
|
|
16
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
17
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
18
|
+
in the Software without restriction, including without limitation the rights
|
|
19
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
20
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
21
|
+
furnished to do so, subject to the following conditions:
|
|
22
|
+
|
|
23
|
+
The above copyright notice and this permission notice shall be included in all
|
|
24
|
+
copies or substantial portions of the Software.
|
|
25
|
+
|
|
26
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
27
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
28
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
29
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
30
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
31
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
32
|
+
SOFTWARE.
|
|
33
|
+
|
|
34
|
+
## React DayPicker
|
|
35
|
+
|
|
36
|
+
The MIT License (MIT)
|
|
37
|
+
|
|
38
|
+
Copyright (c) 2014-2025 Giampaolo Bellavite <io@gpbl.dev> and contributors
|
|
39
|
+
|
|
40
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
41
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
42
|
+
in the Software without restriction, including without limitation the rights
|
|
43
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
44
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
45
|
+
furnished to do so, subject to the following conditions:
|
|
46
|
+
|
|
47
|
+
The above copyright notice and this permission notice shall be included in all
|
|
48
|
+
copies or substantial portions of the Software.
|
|
49
|
+
|
|
50
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
51
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
52
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
53
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
54
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
55
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
56
|
+
SOFTWARE.
|
|
57
|
+
|
|
58
|
+
## React Dropzone
|
|
59
|
+
|
|
60
|
+
The MIT License (MIT)
|
|
61
|
+
|
|
62
|
+
Copyright (c) 2018 Param Aggarwal
|
|
63
|
+
|
|
64
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
65
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
66
|
+
in the Software without restriction, including without limitation the rights
|
|
67
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
68
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
69
|
+
furnished to do so, subject to the following conditions:
|
|
70
|
+
|
|
71
|
+
The above copyright notice and this permission notice shall be included in all
|
|
72
|
+
copies or substantial portions of the Software.
|
|
73
|
+
|
|
74
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
75
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
76
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
77
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
78
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
79
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
80
|
+
SOFTWARE.
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
## Breadcrumb and Separator adaptations
|
|
85
|
+
|
|
86
|
+
Breadcrumb adapts shadcn/ui's composable breadcrumb source (https://github.com/shadcn-ui/ui/blob/main/apps/v4/registry/new-york-v4/ui/breadcrumb.tsx), replacing Tailwind, Slot and Lucide with local CSS and native elements. Separator adapts the orientation and decorative semantics from https://github.com/radix-ui/primitives/blob/main/packages/react/separator/src/separator.tsx using a native div; the Radix MIT notice above applies. No new runtime dependencies are required.
|
|
87
|
+
|
|
88
|
+
## shadcn/ui
|
|
89
|
+
|
|
90
|
+
MIT License
|
|
91
|
+
|
|
92
|
+
Copyright (c) 2023 shadcn
|
|
93
|
+
|
|
94
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
95
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
96
|
+
in the Software without restriction, including without limitation the rights
|
|
97
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
98
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
99
|
+
furnished to do so, subject to the following conditions:
|
|
100
|
+
|
|
101
|
+
The above copyright notice and this permission notice shall be included in all
|
|
102
|
+
copies or substantial portions of the Software.
|
|
103
|
+
|
|
104
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
105
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
106
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
107
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
108
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
109
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
110
|
+
SOFTWARE.
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
## Leaflet
|
|
114
|
+
|
|
115
|
+
The library stylesheet includes Leaflet CSS and its referenced marker images.
|
|
116
|
+
|
|
117
|
+
BSD 2-Clause License
|
|
118
|
+
|
|
119
|
+
Copyright (c) 2010-2023, Volodymyr Agafonkin
|
|
120
|
+
Copyright (c) 2010-2011, CloudMade
|
|
121
|
+
All rights reserved.
|
|
122
|
+
|
|
123
|
+
Redistribution and use in source and binary forms, with or without
|
|
124
|
+
modification, are permitted provided that the following conditions are met:
|
|
125
|
+
|
|
126
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
127
|
+
list of conditions and the following disclaimer.
|
|
128
|
+
|
|
129
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
130
|
+
this list of conditions and the following disclaimer in the documentation
|
|
131
|
+
and/or other materials provided with the distribution.
|
|
132
|
+
|
|
133
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
134
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
135
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
136
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
137
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
138
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
139
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
140
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
141
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
142
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|