@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
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Avatar
3
- summary: The picture of a person or an organization, alone or in a group.
3
+ summary: A person's or organization's picture, alone or in a group.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Data display
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Box
3
- summary: A plain block for an inset, a size container or a named region.
3
+ summary: A plain block for padding, container queries, or a name that styles and tests can target.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Breadcrumbs
3
- summary: The path from the top level to the current page, with earlier levels as links or buttons.
3
+ summary: The path to the current page, with a link back to each level above it.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Navigation
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Card
3
- summary: A rounded surface that groups content about one subject.
3
+ summary: A container that groups content about one subject.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Checkbox
3
- summary: A choice people turn on or off on its own.
3
+ summary: An option people turn on or off, independent of the others.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: ColorPicker
3
- summary: Chooses a color, in the formats people work in.
3
+ summary: Picks a color, as hex, RGB or HSL.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Column
3
- summary: Lays out content one under another with even gaps.
3
+ summary: Stacks content vertically with even gaps.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Combobox
3
- summary: A text field that filters a list of options as people type, to choose one option or, as chips, several.
3
+ summary: A text field that filters options as people type, to pick one or several as chips.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Composer
3
- summary: The message field of a conversation, which grows with its text.
3
+ summary: A chat message field that grows as people type.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Text & content
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: ConfirmDialog
3
- summary: Asks people to confirm an action whose consequence needs a sentence.
3
+ summary: A dialog that asks people to confirm an action before it runs.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Overlays
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: DatePicker
3
- summary: A field that opens a calendar to choose a date, or a date and time, and the calendar on its own.
3
+ summary: A date field with a calendar, for a date or a date and time. The calendar also works on its own.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: DescriptionList
3
- summary: The facts about one thing, as labels and their values.
3
+ summary: Labels and their values, describing one thing.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Data display
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Dialog
3
- summary: A focused task over the page.
3
+ summary: A window over the page for one focused task.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Overlays
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: DocumentTabs
3
- summary: Editor-style tabs for the documents people have open.
3
+ summary: Tabs for open documents, as in a code editor.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Navigation
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: EmptyState
3
- summary: What a region shows when it has nothing to show, with a way to fill it.
3
+ summary: Shown when a region has no content, with an action to add some.
4
4
  status: beta
5
5
  since: 2.0.0
6
6
  category: Feedback
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Field
3
- summary: The label, description and error around a control envUI has no field for.
3
+ summary: Adds a label, description and error message to a custom control.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Graphic
3
- summary: The application's own logo, icon or picture, at one of envUI's sizes.
3
+ summary: Your app's logo, icon or image, at one of envUI's sizes.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Data display
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Halo
3
- summary: A soft halo that breathes around the one control or region to look at next.
3
+ summary: A pulsing glow that points people to the next control to use.
4
4
  status: beta
5
5
  since: 3.0.0
6
6
  category: Feedback
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: HoverCard
3
- summary: A card of supplementary details that opens beside a link, like a link preview.
3
+ summary: A card with more details that opens when people hover or focus a link, like a link preview.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Overlays
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Kbd
3
- summary: Key caps that show a key, or keys pressed together.
3
+ summary: Shows a keyboard key or a shortcut.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Text & content
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Link
3
- summary: A destination inside running text, underlined by default, routed by the application.
3
+ summary: A link in text, underlined by default, that goes through your app's router.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Actions
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: List
3
- summary: A column of discrete items people scan, open or choose, as joined filled rows.
3
+ summary: Items people scan, open or select, shown as rows.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Data display
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Markdown
3
- summary: Shows a Markdown string in envUI's typography.
3
+ summary: Renders Markdown text in envUI's text styles.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Text & content
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Menu
3
- summary: Actions and destinations, opened from a trigger or a right click.
3
+ summary: A list of actions and links, opened from a button or a right click.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Actions
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Message
3
- summary: The entries of a conversation, your own as bubbles and others at full width.
3
+ summary: 'Chat messages: yours as bubbles, others at full width.'
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Text & content
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: MonthPicker
3
- summary: A field that opens a year of months to choose a month.
3
+ summary: A field for picking a month from a view of the year.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: NavigationDrawer
3
- summary: An application's main destinations, in a drawer, a rail or a bar by the window's width.
3
+ summary: An app's main navigation, shown as a drawer, a rail or a bar depending on the window width.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Navigation
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Page
3
- summary: The column a page's content sits in, under its title and actions.
3
+ summary: The content column of a page, below its title and actions.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Panes
3
- summary: A region split into two panes side by side, such as a document and its details.
3
+ summary: Two panes side by side, such as a document and its details.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Popover
3
- summary: A floating panel beside its trigger, for details or a small form.
3
+ summary: A floating panel next to the control that opens it, for details or a small form.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Overlays
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Progress
3
- summary: How much of a task is done, or that it runs while the amount is unknown.
3
+ summary: Shows how much of a task is done, or that it is still running.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Feedback
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Radio
3
- summary: One choice from up to five options, all in view, listed one under the other.
3
+ summary: Picks one of up to five options, all visible at once.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: RelativeTime
3
- summary: A moment as text relative to now, such as 3 hours ago, kept current.
3
+ summary: A time shown relative to now, such as 3 hours ago, kept up to date.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Data display
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: ResizeHandle
3
- summary: A handle people drag, or move with the keys, to resize what is beside it.
3
+ summary: A handle that resizes the area next to it, by dragging or with the arrow keys.
4
4
  status: beta
5
5
  since: 2.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Row
3
- summary: Lays out content side by side with even gaps, wrapping when it doesn't fit.
3
+ summary: Places content side by side with even gaps, wrapping when it doesn't fit.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Scaffold
3
- summary: The frame of an application's screen, around its top bar, its navigation and the page.
3
+ summary: 'The layout of an app screen: top bar, navigation and page.'
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: SegmentedControl
3
- summary: One choice among a few views or filters of the same content.
3
+ summary: Switches between a few views or filters of the same content.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Select
3
- summary: One choice from a list that stays collapsed until opened.
3
+ summary: A dropdown for picking one option.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Slider
3
- summary: A value in a known range, chosen by dragging or with the keyboard.
3
+ summary: Picks a value in a range, by dragging or with the keyboard.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Spinner
3
- summary: Work of unknown length in a small area, such as a panel that is updating, as a turning arc.
3
+ summary: A spinning arc that shows a small area is loading.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Feedback
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Surface
3
- summary: A container with a background, an inset and corners, but no layout of its own.
3
+ summary: A container with a background, padding and rounded corners, but no layout.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: TableOfContents
3
- summary: The page's sections as links, with the one the reader is in marked.
3
+ summary: Links to the page's sections, with the current one highlighted.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Navigation
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Table
3
- summary: 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.
3
+ summary: Rows of data in columns, with your own content in the cells.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Data display
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: TimePicker
3
- summary: A field that opens wheels of hours and minutes to choose a time of day, on the locale's own clock.
3
+ summary: A field for picking a time, on a 12- or 24-hour clock by locale.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Forms & selection
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Toolbar
3
- summary: A bar of icon buttons for one subject, such as an editor's formatting, in a row or a column.
3
+ summary: A row or column of icon buttons, such as an editor's formatting tools.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: Actions
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: TopBar
3
- summary: The bar at the top of an application or a screen, with its title, centered content and actions.
3
+ summary: The bar at the top of an app or a screen, with a title and actions.
4
4
  status: beta
5
5
  since: 1.0.0
6
6
  category: App frame & layout
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Tree
3
- summary: A tree of rows for large hierarchies, such as file trees, with keyboard navigation and a context menu.
3
+ summary: Nested rows for large hierarchies such as file trees, with keyboard navigation and a context menu.
4
4
  status: stable
5
5
  since: 1.0.0
6
6
  category: Navigation
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Accessibility
3
- summary: What every component does for keyboard, screen readers, contrast, motion and touch, and what an app still supplies.
3
+ summary: What components handle for keyboard, screen readers, contrast, motion and touch, and what your app adds.
4
4
  aliases:
5
5
  - a11y
6
6
  - keyboard
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Icons
3
- summary: Thousands of Material Symbols, sized by their component, outlined or filled.
3
+ summary: Thousands of Material Symbols, outlined or filled, sized to fit each component.
4
4
  components:
5
5
  - Icon
6
6
  aliases:
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Adapting to width
3
- summary: Components follow the space they sit in, and four window classes name where a layout changes.
3
+ summary: Components adapt to their container, and four window sizes set where layouts change.
4
4
  components:
5
5
  - useContainerSize
6
6
  - windowClassOf
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Spacing & density
3
- summary: How space groups things, controls line up, the compact scale and tighter rows, and what corners say.
3
+ summary: How spacing groups content, how controls align, compact density and corner radius.
4
4
  aliases:
5
5
  - scale
6
6
  - density
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Typography
3
- summary: A few text styles, each with one job, from a page's hero line to small notes.
3
+ summary: A small set of text styles, from page headlines to captions.
4
4
  components:
5
5
  - Text
6
6
  aliases: