@envsemble/envui 3.0.0 → 3.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.
Files changed (63) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +13 -25
  3. package/dist/assets/readme/overview-dark.png +0 -0
  4. package/dist/assets/readme/overview-light.png +0 -0
  5. package/dist/styles/Code.css +1 -1
  6. package/dist/styles.css +1 -1
  7. package/docs/components/avatar.md +1 -1
  8. package/docs/components/box.md +1 -1
  9. package/docs/components/breadcrumbs.md +1 -1
  10. package/docs/components/card.md +1 -1
  11. package/docs/components/checkbox.md +1 -1
  12. package/docs/components/color-picker.md +1 -1
  13. package/docs/components/column.md +1 -1
  14. package/docs/components/combobox.md +1 -1
  15. package/docs/components/composer.md +1 -1
  16. package/docs/components/confirm-dialog.md +1 -1
  17. package/docs/components/date-picker.md +1 -1
  18. package/docs/components/description-list.md +1 -1
  19. package/docs/components/dialog.md +1 -1
  20. package/docs/components/document-tabs.md +1 -1
  21. package/docs/components/empty-state.md +1 -1
  22. package/docs/components/field.md +1 -1
  23. package/docs/components/graphic.md +1 -1
  24. package/docs/components/halo.md +1 -1
  25. package/docs/components/hover-card.md +1 -1
  26. package/docs/components/kbd.md +1 -1
  27. package/docs/components/link.md +1 -1
  28. package/docs/components/list.md +1 -1
  29. package/docs/components/markdown.md +1 -1
  30. package/docs/components/menu.md +1 -1
  31. package/docs/components/message.md +1 -1
  32. package/docs/components/month-picker.md +1 -1
  33. package/docs/components/navigation-drawer.md +1 -1
  34. package/docs/components/page.md +1 -1
  35. package/docs/components/panes.md +1 -1
  36. package/docs/components/popover.md +1 -1
  37. package/docs/components/progress.md +1 -1
  38. package/docs/components/radio.md +1 -1
  39. package/docs/components/relative-time.md +1 -1
  40. package/docs/components/resize-handle.md +1 -1
  41. package/docs/components/row.md +1 -1
  42. package/docs/components/scaffold.md +1 -1
  43. package/docs/components/segmented-control.md +1 -1
  44. package/docs/components/select.md +1 -1
  45. package/docs/components/slider.md +1 -1
  46. package/docs/components/spinner.md +1 -1
  47. package/docs/components/surface.md +1 -1
  48. package/docs/components/table-of-contents.md +1 -1
  49. package/docs/components/table.md +1 -1
  50. package/docs/components/time-picker.md +1 -1
  51. package/docs/components/toolbar.md +1 -1
  52. package/docs/components/top-bar.md +1 -1
  53. package/docs/components/tree.md +1 -1
  54. package/docs/foundations/accessibility.md +1 -1
  55. package/docs/foundations/icons.md +1 -1
  56. package/docs/foundations/responsive.md +1 -1
  57. package/docs/foundations/spacing.md +1 -1
  58. package/docs/foundations/typography.md +1 -1
  59. package/docs/index.md +52 -52
  60. package/docs/setup.md +2 -2
  61. package/package.json +1 -1
  62. package/dist/assets/readme/gallery-dark.png +0 -0
  63. package/dist/assets/readme/gallery-light.png +0 -0
package/docs/index.md CHANGED
@@ -20,98 +20,98 @@ Where things are in `node_modules/@envsemble/envui/`:
20
20
  ## Foundations
21
21
 
22
22
  - [Colors & themes](foundations/colors.md) — Colors named by their role, so every screen works in light, dark and high contrast.
23
- - [Typography](foundations/typography.md) — A few text styles, each with one job, from a page's hero line to small notes.
24
- - [Spacing & density](foundations/spacing.md) — How space groups things, controls line up, the compact scale and tighter rows, and what corners say.
25
- - [Adapting to width](foundations/responsive.md) — Components follow the space they sit in, and four window classes name where a layout changes.
26
- - [Icons](foundations/icons.md) — Thousands of Material Symbols, sized by their component, outlined or filled.
27
- - [Accessibility](foundations/accessibility.md) — What every component does for keyboard, screen readers, contrast, motion and touch, and what an app still supplies.
23
+ - [Typography](foundations/typography.md) — A small set of text styles, from page headlines to captions.
24
+ - [Spacing & density](foundations/spacing.md) — How spacing groups content, how controls align, compact density and corner radius.
25
+ - [Adapting to width](foundations/responsive.md) — Components adapt to their container, and four window sizes set where layouts change.
26
+ - [Icons](foundations/icons.md) — Thousands of Material Symbols, outlined or filled, sized to fit each component.
27
+ - [Accessibility](foundations/accessibility.md) — What components handle for keyboard, screen readers, contrast, motion and touch, and what your app adds.
28
28
 
29
29
  ## Actions
30
30
 
31
31
  - [Button](components/button.md) — Starts an action, or goes to a destination as a link.
32
- - [Link](components/link.md) — A destination inside running text, underlined by default, routed by the application.
33
- - [Toolbar](components/toolbar.md) — A bar of icon buttons for one subject, such as an editor's formatting, in a row or a column.
34
- - [Menu](components/menu.md) — Actions and destinations, opened from a trigger or a right click.
32
+ - [Link](components/link.md) — A link in text, underlined by default, that goes through your app's router.
33
+ - [Toolbar](components/toolbar.md) — A row or column of icon buttons, such as an editor's formatting tools.
34
+ - [Menu](components/menu.md) — A list of actions and links, opened from a button or a right click.
35
35
  - [Menubar](components/menubar.md) — A desktop-style bar of menus, such as File, Edit and View.
36
36
  - [CommandPalette](components/command-palette.md) — A quick-open dialog that finds a document, a page, a person or a command by name.
37
37
 
38
38
  ## Forms & selection
39
39
 
40
40
  - [TextField](components/text-field.md) — A field for entering text, on one line or several.
41
- - [Field](components/field.md) — The label, description and error around a control envUI has no field for.
42
- - [Select](components/select.md) — One choice from a list that stays collapsed until opened.
43
- - [Combobox](components/combobox.md) — A text field that filters a list of options as people type, to choose one option or, as chips, several.
44
- - [Checkbox](components/checkbox.md) — A choice people turn on or off on its own.
45
- - [Radio](components/radio.md) — One choice from up to five options, all in view, listed one under the other.
41
+ - [Field](components/field.md) — Adds a label, description and error message to a custom control.
42
+ - [Select](components/select.md) — A dropdown for picking one option.
43
+ - [Combobox](components/combobox.md) — A text field that filters options as people type, to pick one or several as chips.
44
+ - [Checkbox](components/checkbox.md) — An option people turn on or off, independent of the others.
45
+ - [Radio](components/radio.md) — Picks one of up to five options, all visible at once.
46
46
  - [Switch](components/switch.md) — An on/off setting that takes effect as soon as it changes.
47
- - [SegmentedControl](components/segmented-control.md) — One choice among a few views or filters of the same content.
48
- - [Slider](components/slider.md) — A value in a known range, chosen by dragging or with the keyboard.
49
- - [DatePicker](components/date-picker.md) — A field that opens a calendar to choose a date, or a date and time, and the calendar on its own.
50
- - [TimePicker](components/time-picker.md) — A field that opens wheels of hours and minutes to choose a time of day, on the locale's own clock.
51
- - [MonthPicker](components/month-picker.md) — A field that opens a year of months to choose a month.
52
- - [ColorPicker](components/color-picker.md) — Chooses a color, in the formats people work in.
47
+ - [SegmentedControl](components/segmented-control.md) — Switches between a few views or filters of the same content.
48
+ - [Slider](components/slider.md) — Picks a value in a range, by dragging or with the keyboard.
49
+ - [DatePicker](components/date-picker.md) — A date field with a calendar, for a date or a date and time. The calendar also works on its own.
50
+ - [TimePicker](components/time-picker.md) — A field for picking a time, on a 12- or 24-hour clock by locale.
51
+ - [MonthPicker](components/month-picker.md) — A field for picking a month from a view of the year.
52
+ - [ColorPicker](components/color-picker.md) — Picks a color, as hex, RGB or HSL.
53
53
  - [DropZone](components/drop-zone.md) — An area that takes dropped files and opens the file picker when pressed.
54
54
 
55
55
  ## Navigation
56
56
 
57
- - [NavigationDrawer](components/navigation-drawer.md) — An application's main destinations, in a drawer, a rail or a bar by the window's width.
58
- - [Breadcrumbs](components/breadcrumbs.md) — The path from the top level to the current page, with earlier levels as links or buttons.
59
- - [TableOfContents](components/table-of-contents.md) — The page's sections as links, with the one the reader is in marked.
57
+ - [NavigationDrawer](components/navigation-drawer.md) — An app's main navigation, shown as a drawer, a rail or a bar depending on the window width.
58
+ - [Breadcrumbs](components/breadcrumbs.md) — The path to the current page, with a link back to each level above it.
59
+ - [TableOfContents](components/table-of-contents.md) — Links to the page's sections, with the current one highlighted.
60
60
  - [Pager](components/pager.md) — Previous and next links between the pages of an ordered sequence, such as a guide.
61
61
  - [Pagination](components/pagination.md) — Previous and next page buttons, with the range of items shown.
62
- - [Tree](components/tree.md) — A tree of rows for large hierarchies, such as file trees, with keyboard navigation and a context menu.
63
- - [DocumentTabs](components/document-tabs.md) — Editor-style tabs for the documents people have open.
62
+ - [Tree](components/tree.md) — Nested rows for large hierarchies such as file trees, with keyboard navigation and a context menu.
63
+ - [DocumentTabs](components/document-tabs.md) — Tabs for open documents, as in a code editor.
64
64
 
65
65
  ## Data display
66
66
 
67
- - [Table](components/table.md) — A shell for rows of anything; the frame, the rows, their states and layout are the table's, and what goes in the cells is yours.
68
- - [List](components/list.md) — A column of discrete items people scan, open or choose, as joined filled rows.
69
- - [DescriptionList](components/description-list.md) — The facts about one thing, as labels and their values.
67
+ - [Table](components/table.md) — Rows of data in columns, with your own content in the cells.
68
+ - [List](components/list.md) — Items people scan, open or select, shown as rows.
69
+ - [DescriptionList](components/description-list.md) — Labels and their values, describing one thing.
70
70
  - [Badge](components/badge.md) — A small static label for a state, a count or a piece of metadata.
71
- - [Avatar](components/avatar.md) — The picture of a person or an organization, alone or in a group.
72
- - [Graphic](components/graphic.md) — The application's own logo, icon or picture, at one of envUI's sizes.
71
+ - [Avatar](components/avatar.md) — A person's or organization's picture, alone or in a group.
72
+ - [Graphic](components/graphic.md) — Your app's logo, icon or image, at one of envUI's sizes.
73
73
  - [Meter](components/meter.md) — A measurement within a known range, such as the storage used of a quota.
74
- - [RelativeTime](components/relative-time.md) — A moment as text relative to now, such as 3 hours ago, kept current.
74
+ - [RelativeTime](components/relative-time.md) — A time shown relative to now, such as 3 hours ago, kept up to date.
75
75
 
76
76
  ## Text & content
77
77
 
78
- - [Markdown](components/markdown.md) — Shows a Markdown string in envUI's typography.
78
+ - [Markdown](components/markdown.md) — Renders Markdown text in envUI's text styles.
79
79
  - [Code](components/code.md) — Code in text and in blocks, and the changes between two versions of a file.
80
- - [Kbd](components/kbd.md) — Key caps that show a key, or keys pressed together.
80
+ - [Kbd](components/kbd.md) — Shows a keyboard key or a shortcut.
81
81
  - [VisuallyHidden](components/visually-hidden.md) — Text that assistive technology reads and the screen doesn't show.
82
- - [Message](components/message.md) — The entries of a conversation, your own as bubbles and others at full width.
83
- - [Composer](components/composer.md) — The message field of a conversation, which grows with its text.
82
+ - [Message](components/message.md) — Chat messages: yours as bubbles, others at full width.
83
+ - [Composer](components/composer.md) — A chat message field that grows as people type.
84
84
  - [Accordion](components/accordion.md) — Stacked sections that each show and hide their content under a heading.
85
85
  - [Disclosure](components/disclosure.md) — A one-line summary that shows and hides optional details below it.
86
86
 
87
87
  ## Feedback
88
88
 
89
89
  - [Alert](components/alert.md) — An inline message about a page or a section, with an optional action.
90
- - [EmptyState](components/empty-state.md) — What a region shows when it has nothing to show, with a way to fill it.
90
+ - [EmptyState](components/empty-state.md) — Shown when a region has no content, with an action to add some.
91
91
  - [Toast](components/toast.md) — Brief feedback after an action, at the edge of the window.
92
- - [Progress](components/progress.md) — How much of a task is done, or that it runs while the amount is unknown.
93
- - [Spinner](components/spinner.md) — Work of unknown length in a small area, such as a panel that is updating, as a turning arc.
94
- - [Halo](components/halo.md) — A soft halo that breathes around the one control or region to look at next.
92
+ - [Progress](components/progress.md) — Shows how much of a task is done, or that it is still running.
93
+ - [Spinner](components/spinner.md) — A spinning arc that shows a small area is loading.
94
+ - [Halo](components/halo.md) — A pulsing glow that points people to the next control to use.
95
95
 
96
96
  ## Overlays
97
97
 
98
- - [Dialog](components/dialog.md) — A focused task over the page.
99
- - [ConfirmDialog](components/confirm-dialog.md) — Asks people to confirm an action whose consequence needs a sentence.
98
+ - [Dialog](components/dialog.md) — A window over the page for one focused task.
99
+ - [ConfirmDialog](components/confirm-dialog.md) — A dialog that asks people to confirm an action before it runs.
100
100
  - [Sheet](components/sheet.md) — A panel that slides in over the page from an edge of the window.
101
- - [Popover](components/popover.md) — A floating panel beside its trigger, for details or a small form.
102
- - [HoverCard](components/hover-card.md) — A card of supplementary details that opens beside a link, like a link preview.
101
+ - [Popover](components/popover.md) — A floating panel next to the control that opens it, for details or a small form.
102
+ - [HoverCard](components/hover-card.md) — A card with more details that opens when people hover or focus a link, like a link preview.
103
103
  - [Tooltip](components/tooltip.md) — A short label beside a control on hover and keyboard focus.
104
104
 
105
105
  ## App frame & layout
106
106
 
107
- - [Scaffold](components/scaffold.md) — The frame of an application's screen, around its top bar, its navigation and the page.
108
- - [Page](components/page.md) — The column a page's content sits in, under its title and actions.
109
- - [Panes](components/panes.md) — A region split into two panes side by side, such as a document and its details.
110
- - [ResizeHandle](components/resize-handle.md) — A handle people drag, or move with the keys, to resize what is beside it.
111
- - [TopBar](components/top-bar.md) — The bar at the top of an application or a screen, with its title, centered content and actions.
112
- - [Surface](components/surface.md) — A container with a background, an inset and corners, but no layout of its own.
113
- - [Card](components/card.md) — A rounded surface that groups content about one subject.
114
- - [Box](components/box.md) — A plain block for an inset, a size container or a named region.
115
- - [Row](components/row.md) — Lays out content side by side with even gaps, wrapping when it doesn't fit.
116
- - [Column](components/column.md) — Lays out content one under another with even gaps.
107
+ - [Scaffold](components/scaffold.md) — The layout of an app screen: top bar, navigation and page.
108
+ - [Page](components/page.md) — The content column of a page, below its title and actions.
109
+ - [Panes](components/panes.md) — Two panes side by side, such as a document and its details.
110
+ - [ResizeHandle](components/resize-handle.md) — A handle that resizes the area next to it, by dragging or with the arrow keys.
111
+ - [TopBar](components/top-bar.md) — The bar at the top of an app or a screen, with a title and actions.
112
+ - [Surface](components/surface.md) — A container with a background, padding and rounded corners, but no layout.
113
+ - [Card](components/card.md) — A container that groups content about one subject.
114
+ - [Box](components/box.md) — A plain block for padding, container queries, or a name that styles and tests can target.
115
+ - [Row](components/row.md) — Places content side by side with even gaps, wrapping when it doesn't fit.
116
+ - [Column](components/column.md) — Stacks content vertically with even gaps.
117
117
  - [Grid](components/grid.md) — Lays out content in columns with even gaps.
package/docs/setup.md CHANGED
@@ -66,8 +66,8 @@ aliases:
66
66
  envUI is React components and design tokens for React and React DOM 19. Install an exact version, with the lint packages at the same one, and read the docs shipped with it.
67
67
 
68
68
  ```sh
69
- npm install --save-exact @envsemble/envui@3.0.0
70
- npm install --save-dev --save-exact @envsemble/eslint-plugin-envui@3.0.0 @envsemble/stylelint-config-envui@3.0.0
69
+ npm install --save-exact @envsemble/envui@3.0.1
70
+ npm install --save-dev --save-exact @envsemble/eslint-plugin-envui@3.0.1 @envsemble/stylelint-config-envui@3.0.1
71
71
  ```
72
72
 
73
73
  Each lint package's README says how to turn it on. The ESLint plugin's `configs.recommended` reports envUI used wrongly; `configs.strict` also holds the application to envUI's components in place of plain HTML and to the words of its [writing guide](writing.md).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@envsemble/envui",
3
- "version": "3.0.0",
3
+ "version": "3.0.1",
4
4
  "description": "A React design system for B2B SaaS products and AI developer tools, documented for people and coding agents",
5
5
  "homepage": "https://github.com/envsemble/envUI#readme",
6
6
  "bugs": {
Binary file