@staqforce.studio/staqui 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2026 StaqUI contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+Research captures under research/sources retain the copyright of their source.
+The MIT license applies to original StaqUI implementation and documentation.

package/README.md

@@ -1,3 +1,58 @@
-# Temporary Holding Version
+# StaqUI
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An independent React and TypeScript UI library with 50 catalog components, semantic light/dark themes, and compact and comfortable densities. No Shopify or Next.js runtime dependency.
+
+## Install
+
+After the first public release, install from npm using your preferred package manager:
+
+```sh
+npm install @staqforce.studio/staqui
+pnpm add @staqforce.studio/staqui
+bun add @staqforce.studio/staqui
+```
+
+Use one of these commands in an existing React application. For an unpublished
+checkout, run `pnpm pack:ui` at the repository root and install the generated
+`artifacts/staqforce.studio-staqui-<version>.tgz` instead. See the repository's
+[PUBLISHING.md](https://github.com/regzimarx/StaqUI/blob/main/PUBLISHING.md) for release instructions.
+
+React and React DOM 18.3 or 19 are peer dependencies. ESM, CommonJS, TypeScript declarations and CSS are included. Load styles once in your application's entry point or root layout.
+
+```tsx
+import { StaqProvider, Stack, TextField, Button } from '@staqforce.studio/staqui';
+import '@staqforce.studio/staqui/styles.css';
+
+export default function App() {
+  return (
+    <StaqProvider theme="light" density="compact">
+      <form onSubmit={(event) => event.preventDefault()}>
+        <Stack>
+          <TextField label="Project name" required />
+          <Button type="submit" variant="primary">Create project</Button>
+        </Stack>
+      </form>
+    </StaqProvider>
+  );
+}
+```
+
+Use `theme="dark"` for the alternate theme and `density="comfortable"` for roomier 40px controls; `density="compact"` is the default with 32px controls. Add `asChild` to `Button` to render its styles onto a single child element, such as a framework link: `<Button asChild variant="primary"><a href="/start">Start</a></Button>`. With `asChild`, put the label and any icon inside that child; the button's own `icon` and `loading` slots apply only to real buttons. Use `theme="staqwish"` for the neutral Shopify admin-inspired visual system extracted from the Staqwish project. Components wrapping native elements accept React HTML and ARIA attributes. Fields use `label`, `description`, `error`, and `onValueChange`; checkboxes and switches use `onCheckedChange`. Overlays use `open` and `onOpenChange`.
+
+## Customization
+
+Override the `--sq-*` CSS custom properties after importing the stylesheet. Theme-specific overrides should target `[data-staq-theme]`. Built-in theme and density propagate to portals. Scope custom brand overrides globally or explicitly include `.sq-modal`, `.sq-menu`, `.sq-popover` and `.sq-tooltip`; custom ancestor-only CSS does not cross portal boundaries.
+
+## Accessibility
+
+Native inputs provide labels, autofill and constraint validation. Radix handles overlays and focus management; React DayPicker handles calendars. Always supply meaningful labels, descriptions, alternative text, and valid heading structure. Target: WCAG 2.2 AA, not a conformance certification. Perform assistive-technology testing in your consuming application.
+
+## Scope
+
+This is an independent equivalent of the reference component catalog component catalog, not a compatible Shopify API implementation. Color inputs use native six-digit RGB hex; date fields use native browser UI; the calendar uses Date objects and matcher constraints. The icon set is Lucide. Table sorting is client-side and pagination is application-owned. File uploads and all backend/service behavior belong to the consuming application.
+
+For the full component API, examples, and per-component adaptations, run the documentation site from the repository with `pnpm dev`. The repository also includes `research/INVENTORY.md` and `research/COVERAGE.md`.
+
+MIT licensed. Dependencies retain their respective licenses.
+
+Fixel Display is the default font, bundled as self-hosted WOFF2 files (weights 100–900, upright and italic) with its OFL license. Importing the stylesheet loads the font; override `--sq-font` to use another family. Unsupported scripts fall back to the system font stack. Corners use an 8/12/20px scale for small, medium, and large radii.

package/dist/fonts/LICENSE

@@ -0,0 +1,87 @@
+© 2023 MacPaw Inc. (Authors: Alfabravo + MacPaw)
+
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/fonts/README.md

@@ -0,0 +1,5 @@
+Fixel Display by MacPaw and AlfaBravo.
+
+Source: https://fixel.macpaw.com/ (official FixelAll.zip distribution).
+Unmodified WOFF2 files, weights 100–900, upright and italic.
+Copyright and SIL OFL 1.1 are included in LICENSE.