Skip to content

Commit 60cd525

Browse files
authored
DS Site: Reflect move to @automattic/ui (#104328)
* DS Site: Reflect move to `@automattic/ui` * Improve package descriptions
1 parent 17d3deb commit 60cd525

File tree

4 files changed

+27
-6
lines changed

4 files changed

+27
-6
lines changed
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1-
# `@automattic/ui`
1+
# @automattic/ui
22

3-
Coming soon.
3+
[![NPM Version](https://img.shields.io/npm/v/%40automattic%2Fui)](https://www.npmjs.com/package/@automattic/ui)
4+
5+
Used on top of the [WordPress Design System](./wp-components/) layer.
6+
7+
This package of Automattic UI components is designed to be safe for bundling anywhere.
8+
9+
- No dependency on `@wordpress/components`.
10+
- No CSS collisions when multiple versions of the package are loaded in the same page.
11+
- No need for a separate RTL stylesheet.
12+
- SSR-friendly.

apps/design-system-docs/docs/components/packages/index.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@ sidebar_position: 2
33
---
44

55
# Package Reference
6-
7-
Add content here.

apps/design-system-docs/docs/components/packages/wp-components/data.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,16 @@ export const data: ComponentData[] = [
6666
docs: 'https://wordpress.github.io/gutenberg/?path=/docs/components-animate--docs',
6767
notes: 'Planned for deprecation.',
6868
},
69+
{
70+
id: 'badge',
71+
name: 'Badge',
72+
whereUsed: 'global',
73+
status: 'stable',
74+
figma:
75+
'https://www.figma.com/design/804HN2REV2iap2ytjRQ055/WordPress-Design-System?node-id=19297-39220&t=YhMXMUEdznvUwLv9-4',
76+
docs: 'https://wordpress.github.io/gutenberg/?path=/docs/components-badge--docs',
77+
notes: 'Still a private API. If possible, use `Badge` from `@automattic/ui` instead.',
78+
},
6979
{
7080
id: 'base-control',
7181
name: 'BaseControl',
@@ -200,7 +210,7 @@ export const data: ComponentData[] = [
200210
whereUsed: 'global',
201211
status: 'use-with-caution',
202212
docs: 'https://wordpress.github.io/gutenberg/?path=/docs/components-datepicker--docs',
203-
notes: 'If possible, use `DateCalendar` from `@automattic/components` instead.',
213+
notes: 'If possible, use `DateCalendar` from `@automattic/ui` instead.',
204214
},
205215
{
206216
id: 'date-time-picker',
@@ -209,7 +219,7 @@ export const data: ComponentData[] = [
209219
status: 'use-with-caution',
210220
docs: 'https://wordpress.github.io/gutenberg/?path=/docs/components-datetimepicker--docs',
211221
notes:
212-
'If possible, use `DateCalendar` from `@automattic/components` instead. For the input fields, consider using an `TextControl` with `type="date"` or `type="datetime-local"`.',
222+
'If possible, use `DateCalendar` from `@automattic/ui` instead. For the input fields, consider using an `TextControl` with `type="date"` or `type="datetime-local"`.',
213223
},
214224
{
215225
id: 'disabled',

apps/design-system-docs/docs/components/packages/wp-components/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ import { WPComponentsTable } from './wp-components-table';
66

77
# @wordpress/components
88

9+
[![NPM Version](https://img.shields.io/npm/v/%40wordpress%2Fcomponents)](https://www.npmjs.com/package/@wordpress/components)
10+
11+
Used as the base layer for the Automattic Design System.
12+
913
<WPComponentsTable />

0 commit comments

Comments
 (0)