diff --git a/.changeset/fix-readme-exports-2-0-1-beta.md b/.changeset/fix-readme-exports-2-0-1-beta.md new file mode 100644 index 00000000..1a198cf3 --- /dev/null +++ b/.changeset/fix-readme-exports-2-0-1-beta.md @@ -0,0 +1,11 @@ +--- +"@esnet/packets-ui-react": patch +"@esnet/packets-ui-css": patch +"@esnet/packets-ui-web": patch +--- + +fix: correct README install commands, remove dead exports, fix avatar example + +- README install commands now use the @beta tag so beta testers get 2.x instead of the old 0.x/1.x stable release +- Removed ./style.css export from ui-react exports map: no CSS file ships in the tarball, causing MODULE_NOT_FOUND for consumers who imported it +- Fixed PktsAvatar usage example in ui-react README: initials and color are not props; correct props are alt (for the fallback label) and backgroundColor diff --git a/apps/host-docs/src/components-react.mdx b/apps/host-docs/src/components-react.mdx index b9837cf1..123b3b5c 100644 --- a/apps/host-docs/src/components-react.mdx +++ b/apps/host-docs/src/components-react.mdx @@ -22,7 +22,7 @@ import { Meta } from "@storybook/blocks"; ## Installation - For installation instructions, see **[Installing React Components →](/?path=/docs/about-installing-react-components--docs)** + For installation instructions, see Installing React Components → diff --git a/apps/host-docs/src/components-web.mdx b/apps/host-docs/src/components-web.mdx index bd89612f..155477fc 100644 --- a/apps/host-docs/src/components-web.mdx +++ b/apps/host-docs/src/components-web.mdx @@ -22,7 +22,7 @@ import { Meta } from "@storybook/blocks"; ## Installation - For installation instructions, see **[Installing Web Components →](/?path=/docs/about-installing-web-components--docs)** + For installation instructions, see Installing Web Components → diff --git a/apps/host-docs/src/css.mdx b/apps/host-docs/src/css.mdx index 830d5d92..490ea320 100644 --- a/apps/host-docs/src/css.mdx +++ b/apps/host-docs/src/css.mdx @@ -22,7 +22,7 @@ import { Meta } from "@storybook/blocks"; ## Installation - For installation instructions, see **[Installing CSS Components →](/?path=/docs/about-installing-css-components--docs)** + For installation instructions, see Installing CSS Components → diff --git a/apps/host-docs/src/design-tokens.mdx b/apps/host-docs/src/design-tokens.mdx index 24366fee..8bc851ce 100644 --- a/apps/host-docs/src/design-tokens.mdx +++ b/apps/host-docs/src/design-tokens.mdx @@ -75,9 +75,9 @@ const CustomButton = styled.button` If you're starting a new project or simply want to use Packets components, you **don't need design tokens**. Instead, use one of the component systems: - - **[Installing CSS Components →](/?path=/docs/about-installing-css-components--docs)** - For static sites and no-build projects - - **[Installing Web Components →](/?path=/docs/about-installing-web-components--docs)** - For framework-agnostic applications - - **[Installing React Components →](/?path=/docs/about-installing-react-components--docs)** - For React applications + - Installing CSS Components → - For static sites and no-build projects + - Installing Web Components → - For framework-agnostic applications + - Installing React Components → - For React applications @@ -88,13 +88,13 @@ const CustomButton = styled.button` Browse the design tokens by category: - - **[Colors](/?path=/docs/design-tokens-colors--docs)** - Color ramps and semantic color tokens - - **[Spacing](/?path=/docs/design-tokens-spacing--docs)** - Margin, padding, and gap values - - **[Motion](/?path=/docs/design-tokens-motion--docs)** - Animation durations and easing functions - - **[Breakpoints](/?path=/docs/design-tokens-breakpoints--docs)** - Responsive breakpoint values - - **[Radius & Borders](/?path=/docs/design-tokens-radius-and-borders--docs)** - Border radius and border width values - - **[Elevation & Shadows](/?path=/docs/design-tokens-elevation-and-shadows--docs)** - Box shadow and elevation tokens - - **[Icons](/?path=/docs/design-tokens-icons--docs)** - Icon size and styling tokens + - Colors - Color ramps and semantic color tokens + - Spacing - Margin, padding, and gap values + - Motion - Animation durations and easing functions + - Breakpoints - Responsive breakpoint values + - Radius & Borders - Border radius and border width values + - Elevation & Shadows - Box shadow and elevation tokens + - Icons - Icon size and styling tokens diff --git a/apps/host-docs/src/getting-started.mdx b/apps/host-docs/src/getting-started.mdx index 1b9d396c..d8731708 100644 --- a/apps/host-docs/src/getting-started.mdx +++ b/apps/host-docs/src/getting-started.mdx @@ -29,7 +29,7 @@ import { Paintbrush, Globe, Atom } from "lucide-react"; npm install @esnet/packets-ui-css
- + Installation guide →
@@ -50,7 +50,7 @@ import { Paintbrush, Globe, Atom } from "lucide-react"; npm install @esnet/packets-ui-css @esnet/packets-ui-web
- + Installation guide →
@@ -71,7 +71,7 @@ import { Paintbrush, Globe, Atom } from "lucide-react"; npm install @esnet/packets-ui-css @esnet/packets-ui-react
- + Installation guide →
@@ -195,9 +195,9 @@ import { Paintbrush, Globe, Atom } from "lucide-react"; Installation - CSS guide → - Web guide → - React guide → + CSS guide → + Web guide → + React guide → diff --git a/apps/react-docs/package.json b/apps/react-docs/package.json index dfddef4f..7875da9d 100644 --- a/apps/react-docs/package.json +++ b/apps/react-docs/package.json @@ -5,8 +5,8 @@ "type": "module", "scripts": { "dev": "storybook dev -p 6006", - "build": "node ../../scripts/assemble-cloudflare.mjs", - "build:storybook": "storybook build", + "build": "storybook build", + "build:cloudflare": "node ../../scripts/assemble-cloudflare.mjs", "lint": "eslint ./src/stories/**/*.stories.tsx --max-warnings 0", "preview": "serve storybook-static" }, diff --git a/packages/ui-css/README.md b/packages/ui-css/README.md index cb44b402..81e75c3a 100644 --- a/packages/ui-css/README.md +++ b/packages/ui-css/README.md @@ -7,9 +7,11 @@ Use this package if you want Packets styles without a JavaScript framework. For ## Installation ```bash -npm install @esnet/packets-ui-css +npm install @esnet/packets-ui-css@beta ``` +Once 2.x reaches a stable release, drop the `@beta` tag. + ## Setup ### 1. Add the fonts diff --git a/packages/ui-react/README.md b/packages/ui-react/README.md index 2c07be38..3f6eb19d 100644 --- a/packages/ui-react/README.md +++ b/packages/ui-react/README.md @@ -5,11 +5,13 @@ React components for the [Packets Design System](https://github.com/esnet/packet ## Installation ```bash -npm install @esnet/packets-ui-css @esnet/packets-ui-react +npm install @esnet/packets-ui-css@beta @esnet/packets-ui-react@beta ``` Packets ships styles separately. You must install `@esnet/packets-ui-css` alongside the React package. +Once 2.x reaches a stable release, drop the `@beta` tag. + ### Peer dependencies ```bash @@ -61,7 +63,7 @@ function App() {
Save Changes saved. - +
); } diff --git a/packages/ui-react/package.json b/packages/ui-react/package.json index ecb2e9a4..056e3956 100644 --- a/packages/ui-react/package.json +++ b/packages/ui-react/package.json @@ -89,10 +89,6 @@ "require": "./dist/cjs/bundle.js", "import": "./dist/esm/bundle.js" }, - "./style.css": { - "import": "./dist/esm/style.css", - "require": "./dist/cjs/style.css" - }, "./src/*": "./src/*" } } diff --git a/packages/ui-web/README.md b/packages/ui-web/README.md index f56fad81..9dc9c816 100644 --- a/packages/ui-web/README.md +++ b/packages/ui-web/README.md @@ -5,11 +5,13 @@ Framework-agnostic Web Components for the [Packets Design System](https://github ## Installation ```bash -npm install @esnet/packets-ui-css @esnet/packets-ui-web +npm install @esnet/packets-ui-css@beta @esnet/packets-ui-web@beta ``` Packets ships styles separately. You must install `@esnet/packets-ui-css` alongside the Web Components package. +Once 2.x reaches a stable release, drop the `@beta` tag. + ### Peer dependencies ```bash diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b6de3163..4de0a455 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -500,11 +500,10 @@ importers: version: 4.9.5 packages/ui-css: - dependencies: + devDependencies: '@esnet/pkts-tokens': specifier: workspace:^ version: link:../design-tokens - devDependencies: '@playwright/test': specifier: 1.57.0 version: 1.57.0