@retailcrm/embed-ui-v1-components 0.9.19 → 0.9.22-alpha.1

package/docs/profiles/UiCollapseBox.yml

@@ -1,51 +0,0 @@
-component: UiCollapseBox
-summary: >
-  UiCollapseBox is a structured expandable container with built-in header, state handling,
-  and visual treatment. It is a higher-level companion to UiCollapse.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiCollapseBox
-
-related_components:
-  - UiCollapse
-  - UiCollapseGroup
-
-use_when:
-  - You need a ready-to-use collapsible box.
-  - You need grouped expandable sections with consistent visuals.
-
-avoid_when:
-  - You need a bare collapse primitive without box chrome.
-
-api:
-  key_props:
-    - name: expanded
-    - name: expandable
-    - name: collapsible
-    - name: toggleable
-    - name: disabled
-    - name: color
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: section.ui-v1-collapse-box
-    tag: section
-  notes: Renders one section root with a header button and a collapsible body region.
-
-geometry:
-  layout: block-like collapsible section
-  root_display: flex
-  width_behavior: stretches to container width by default
-
-behavior:
-  notes:
-    - Supports controlled expanded state and grouped interaction.
-
-ai_notes:
-  do:
-    - Use UiCollapseBox for structured disclosure UI.
-  avoid:
-    - Do not rebuild collapse header UI manually when this component already fits.

package/docs/profiles/UiCopyButton.yml

@@ -1,52 +0,0 @@
-component: UiCopyButton
-summary: >
-  UiCopyButton is an action component for copying text values with tooltip feedback.
-  It wraps copy behavior and copied-state hinting into one compact UI.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiCopyButton
-
-related_components:
-  - UiTooltip
-  - UiButton
-
-use_when:
-  - You need a copy-to-clipboard action for a value.
-  - You need built-in hint and copied-state tooltip text.
-
-avoid_when:
-  - You need a generic button with no copy semantics.
-
-api:
-  key_props:
-    - name: text
-    - name: size
-    - name: tooltipOptions
-  slots:
-    - name: trigger
-      zone: trigger
-      creates: Visible trigger content.
-    - name: hint
-      zone: tooltip
-      creates: Default tooltip content.
-    - name: hint-copied
-      zone: tooltip
-      creates: Tooltip content after copy succeeds.
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: div.ui-v1-copy-button
-    tag: div
-  notes: The root wraps the trigger, tooltip, and fallback input for clipboard support.
-
-geometry:
-  layout: inline trigger wrapper
-  root_display: inline-block
-  width_behavior: content-sized by default
-
-ai_notes:
-  do:
-    - Use for copy-specific flows instead of recreating copy state manually.

package/docs/profiles/UiDate.yml

@@ -1,38 +0,0 @@
-component: UiDate
-summary: >
-  UiDate is a display component for formatted date or date-time output. It is for presenting
-  date values, not for editing them.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiDate
-
-use_when:
-  - You need to display a date value.
-  - You need optional time display with locale-aware formatting.
-
-avoid_when:
-  - You need editable date input.
-
-api:
-  key_props:
-    - name: date
-    - name: withTime
-    - name: locale
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: time
-    tag: time
-  notes: Renders one semantic time element with formatted date text.
-
-geometry:
-  layout: inline date text
-  root_display: inline
-  width_behavior: content-sized by content
-
-ai_notes:
-  do:
-    - Use UiDate for formatted output and UiDatePicker for input.

package/docs/profiles/UiDatePicker.yml

@@ -1,59 +0,0 @@
-component: UiDatePicker
-summary: >
-  UiDatePicker combines textbox-like date display, popper behavior, and calendar selection.
-  It supports single-date and range flows, constraints, and quick options.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiDatePicker
-
-related_components:
-  - UiCalendar
-  - UiTextbox
-  - UiPopper
-
-use_when:
-  - You need editable date input.
-  - You need date-range selection through a textbox-plus-popup flow.
-
-avoid_when:
-  - You need always-visible inline calendar selection only.
-
-api:
-  key_props:
-    - name: value
-    - name: type
-    - name: minDate
-    - name: maxDate
-    - name: nullable
-    - name: synchronization
-    - name: quickOptions
-    - name: textboxOptions
-  methods:
-    - name: open
-    - name: close
-    - name: toggle
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: span.ui-v1-date-picker
-    tag: span
-  notes: The visible trigger behaves like an inline date control that opens a floating calendar.
-
-geometry:
-  layout: inline date input trigger
-  root_display: inline-block
-  width_behavior: content-sized by default
-
-behavior:
-  notes:
-    - Supports single-date and range flows.
-    - synchronization controls instant versus confirmed behavior.
-
-ai_notes:
-  do:
-    - Prefer UiDatePicker for typed or popup date input.
-  avoid:
-    - Do not use UiCalendar directly if a textbox trigger is expected.

package/docs/profiles/UiError.yml

@@ -1,32 +0,0 @@
-component: UiError
-summary: >
-  UiError is a compact error-state component for short error messages or fallback states.
-  It is intended for concise inline error display rather than large alert copy.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiError
-
-use_when:
-  - You need a compact error block.
-  - You need inline error text with standard styling.
-
-avoid_when:
-  - You need a richer feedback block, use UiAlert or UiInfobox instead.
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: div.ui-v1-error
-    tag: div
-  notes: Renders one text container for error content.
-
-geometry:
-  layout: block-like error text container
-  root_display: block
-  width_behavior: stretches to container width by default
-
-ai_notes:
-  do:
-    - Use for compact error presentation.

package/docs/profiles/UiImage.yml

@@ -1,39 +0,0 @@
-component: UiImage
-summary: >
-  UiImage is a generic image display component with optional resize and crop hints.
-  Use it for regular visual content rather than identity avatars.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiImage
-
-use_when:
-  - You need to render an image asset.
-  - You need resize or crop hints for image output.
-
-avoid_when:
-  - You need identity-focused avatar UI.
-
-api:
-  key_props:
-    - name: src
-    - name: alt
-    - name: resize
-    - name: crop
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: img
-    tag: img
-  notes: The component renders a single image element.
-
-geometry:
-  layout: replaced media element
-  root_display: inline-block
-  width_behavior: intrinsic by image source or explicit dimensions
-
-ai_notes:
-  do:
-    - Use UiImage for general media and UiAvatar for people or identity.

package/docs/profiles/UiInfobox.yml

@@ -1,45 +0,0 @@
-component: UiInfobox
-summary: >
-  UiInfobox is a richer explanatory block for inline product, warning, or helper content.
-  It can be closable and expandable.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiInfobox
-
-use_when:
-  - You need a highlighted explanatory block.
-  - You need closable or expandable helper content.
-
-avoid_when:
-  - You need a one-line alert only.
-
-api:
-  key_props:
-    - name: title
-    - name: shown
-    - name: expanded
-    - name: expandable
-    - name: closable
-    - name: warning
-  methods:
-    - name: show
-    - name: hide
-    - name: toggle
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: div.ui-v1-infobox
-    tag: div
-  notes: The visible infobox body is wrapped in UiTransition and uses one flex row for media, content, and optional closer.
-
-geometry:
-  layout: block-like message panel
-  root_display: flex
-  width_behavior: stretches to container width by default
-
-ai_notes:
-  do:
-    - Use UiInfobox for richer guidance blocks, not tiny alerts.

package/docs/profiles/UiLink.yml

@@ -1,51 +0,0 @@
-component: UiLink
-summary: >
-  UiLink is the main text-link component for inline navigation and inline actions that should
-  still read as links rather than buttons.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiLink
-
-use_when:
-  - You need inline navigation or linked text.
-  - You need a compact action that should still read as a link.
-
-avoid_when:
-  - You need button semantics, use UiButton instead.
-
-api:
-  key_props:
-    - name: href
-    - name: external
-    - name: appearance
-    - name: size
-    - name: accent
-    - name: ellipsis
-  slots:
-    - name: icon
-      zone: inline-icon
-      creates: Optional icon zone inside the link.
-  emits:
-    - name: click
-    - name: focus
-    - name: blur
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: a.ui-v1-link
-    tag: a
-  notes: The root is one anchor element with inline icon and text zones.
-
-geometry:
-  layout: inline link root
-  root_display: inline-flex
-  width_behavior: content-sized by default
-
-ai_notes:
-  do:
-    - Use UiLink for real link semantics and inline navigation.
-  avoid:
-    - Do not use UiLink where the action should read as a button.

package/docs/profiles/UiLoader.yml

@@ -1,38 +0,0 @@
-component: UiLoader
-summary: >
-  UiLoader displays loading progress or waiting state. It can be used inline or as an overlay.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiLoader
-
-use_when:
-  - You need a visible loading indicator.
-  - You need inline or overlay loading state.
-
-avoid_when:
-  - You need skeleton content rather than a spinner-like loader.
-
-api:
-  key_props:
-    - name: diameter
-    - name: thickness
-    - name: fixed
-    - name: overlay
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: div.ui-v1-loader
-    tag: div
-  notes: The loader body may be wrapped in UiTransition, but the visible loader itself is one div root.
-
-geometry:
-  layout: loader surface or overlay
-  root_display: block
-  width_behavior: content-sized by default, viewport-covering in fixed or overlay modes
-
-ai_notes:
-  do:
-    - Use overlay or fixed only when the loader should escape normal inline flow.

package/docs/profiles/UiMenuItem.yml

@@ -1,57 +0,0 @@
-component: UiMenuItem
-summary: >
-  UiMenuItem is a structured menu row component with support for icons, avatar, description,
-  counters, and active or danger styling.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiMenuItem
-
-use_when:
-  - You need a menu row with structured content zones.
-  - You need icon, avatar, description, or counter inside one menu item.
-
-avoid_when:
-  - You need a plain inline link.
-
-api:
-  key_props:
-    - name: description
-    - name: counter
-    - name: active
-    - name: danger
-    - name: disabled
-    - name: size
-  slots:
-    - name: default
-      zone: main-label
-      creates: Main visible label area.
-    - name: avatar
-      zone: leading-avatar
-      creates: Leading avatar zone.
-    - name: leading-icon
-      zone: leading-icon
-      creates: Leading icon zone.
-    - name: description
-      zone: secondary-copy
-      creates: Secondary description area.
-    - name: trailing-icon
-      zone: trailing-icon
-      creates: Trailing icon zone.
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: div.ui-v1-menu-item
-    tag: div
-  notes: The root is one menu row container with leading, main, and trailing content zones.
-
-geometry:
-  layout: menu row
-  root_display: flex
-  width_behavior: stretches to available menu width
-
-ai_notes:
-  do:
-    - Use structured slots instead of custom wrappers inside menu rows.

package/docs/profiles/UiModalSidebar.yml

@@ -1,46 +0,0 @@
-component: UiModalSidebar
-summary: >
-  UiModalSidebar is a side-docked modal surface with open state, direction, size, and
-  scrolling control. Use it when the UI should slide from an edge instead of opening as a centered dialog.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiModalSidebar
-
-use_when:
-  - You need side-panel modal UI.
-  - You need left or right docked modal content.
-
-avoid_when:
-  - You need a centered dialog.
-
-api:
-  key_props:
-    - name: opened
-    - name: closable
-    - name: direction
-    - name: size
-    - name: scrolling
-    - name: fixed
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: div.ui-v1-modal-sidebar-overlay
-    tag: div
-  notes: The component is teleported; the overlay div contains the actual aside.ui-v1-modal-sidebar panel.
-
-geometry:
-  layout: teleported overlay with side panel
-  root_display: flex
-  width_behavior: viewport-covering overlay with fixed-width sidebar surface
-
-behavior:
-  notes:
-    - opened controls visibility.
-    - direction controls which side the sidebar comes from.
-
-ai_notes:
-  do:
-    - Use UiModalSidebar when page context should stay visually connected to the modal content.

package/docs/profiles/UiModalWindow.yml

@@ -1,44 +0,0 @@
-component: UiModalWindow
-summary: >
-  UiModalWindow is the main centered modal container. It supports open state, closability,
-  appearance variants, fullscreen and responsive behavior, and dialog roles.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiModalWindow
-
-related_components:
-  - UiModalWindowSurface
-
-use_when:
-  - You need a centered dialog.
-  - You need modal interaction with standard dialog semantics.
-
-avoid_when:
-  - You need a side-docked modal, use UiModalSidebar instead.
-
-api:
-  key_props:
-    - name: opened
-    - name: closable
-    - name: appearance
-    - name: fullscreen
-    - name: responsive
-    - name: scrolling
-    - name: role
-  methods:
-    - name: open
-    - name: close
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: div.ui-v1-modal-window via UiModalWindowSurface
-    tag: div
-  notes: The component delegates the actual teleported modal root to UiModalWindowSurface and renders header, content, and footer inside it.
-
-geometry:
-  layout: teleported modal layer with centered surface
-  root_display: flex
-  width_behavior: viewport-covering overlay with content-sized or responsive surface

package/docs/profiles/UiNumberStepper.yml

@@ -1,52 +0,0 @@
-component: UiNumberStepper
-summary: >
-  UiNumberStepper is a numeric input with increase and decrease controls. It is built for
-  constrained numeric entry where arrowing and step-based changes matter.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiNumberStepper
-
-related_components:
-  - UiTextbox
-
-use_when:
-  - You need numeric input with explicit step controls.
-  - You need range constraints and nullable numeric state.
-
-avoid_when:
-  - You need plain text or decimal input without stepper controls.
-
-api:
-  key_props:
-    - name: value
-    - name: min
-    - name: max
-    - name: step
-    - name: decimals
-    - name: clamp
-    - name: nullable
-    - name: direction
-  methods:
-    - name: focus
-    - name: blur
-    - name: increase
-    - name: decrease
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: div.ui-v1-number-stepper
-    tag: div
-  notes: One inline control root wraps the text input and increment or decrement actions.
-
-geometry:
-  layout: inline numeric control
-  root_display: inline-flex
-  width_behavior: content-sized by default
-
-behavior:
-  notes:
-    - Can clamp values into range.
-    - Supports horizontal and vertical direction.

package/docs/profiles/UiRadio.yml

@@ -1,38 +0,0 @@
-component: UiRadio
-summary: >
-  UiRadio is the single-choice selection control for exclusive option sets.
-  It is the radio-style counterpart to UiCheckbox.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiRadio
-
-use_when:
-  - You need one selected value from a fixed set.
-
-avoid_when:
-  - You need multiple independent selections, use UiCheckbox instead.
-
-api:
-  key_props:
-    - name: model
-    - name: value
-    - name: required
-    - name: disabled
-  methods:
-    - name: click
-    - name: focus
-    - name: blur
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: span.ui-v1-radio
-    tag: span
-  notes: One inline wrapper around the visual radio control and label content.
-
-geometry:
-  layout: inline radio control
-  root_display: inline-flex
-  width_behavior: content-sized by default

package/docs/profiles/UiScrollBox.yml

@@ -1,31 +0,0 @@
-component: UiScrollBox
-summary: >
-  UiScrollBox is a scrollable container for constrained content areas. Use it when content
-  should remain inside a dedicated scrolling region instead of growing the whole page.
-
-public_import:
-  from: '@retailcrm/embed-ui-v1-components/remote'
-  named:
-    - UiScrollBox
-
-use_when:
-  - You need a bounded scroll area.
-  - You need long content inside a fixed-height or fixed-width region.
-
-avoid_when:
-  - You need normal page scrolling.
-
-api:
-  key_props: []
-
-rendered_structure:
-  descriptive_only: true
-  root:
-    shape: configurable wrapper tag or PerfectScrollbar root
-    tag: configurable, div by default
-  notes: The root depends on native mode and tag prop, but behaves as a scroll container rather than a visual primitive.
-
-geometry:
-  layout: scroll container
-  root_display: block
-  width_behavior: stretches to the size of its layout context