@rarui/components 1.30.0 → 1.30.2

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 (40) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/custom-elements.json +10 -3
  3. package/dist/index.d.ts +56 -3
  4. package/dist/index.js +31 -25
  5. package/package.json +1 -1
  6. package/src/exhibition/Avatar/README.md +0 -15
  7. package/src/exhibition/Badge/README.md +0 -15
  8. package/src/exhibition/Divider/README.md +0 -15
  9. package/src/exhibition/Icon/README.md +0 -15
  10. package/src/exhibition/Label/README.md +0 -15
  11. package/src/exhibition/Stepper/README.md +0 -15
  12. package/src/exhibition/Text/README.md +0 -15
  13. package/src/exhibition/Title/README.md +0 -15
  14. package/src/exhibition/Tooltip/README.md +0 -15
  15. package/src/feedback/Progress/README.md +0 -15
  16. package/src/feedback/Skeleton/README.md +0 -15
  17. package/src/feedback/Status/README.md +0 -15
  18. package/src/input/Button/README.md +0 -15
  19. package/src/input/Checkbox/README.md +0 -15
  20. package/src/input/Chip/README.md +0 -15
  21. package/src/input/Dropdown/README.md +0 -15
  22. package/src/input/IconButton/README.md +0 -15
  23. package/src/input/Input/README.md +0 -44
  24. package/src/input/RadioButton/README.md +0 -15
  25. package/src/input/Select/README.md +0 -13
  26. package/src/input/Textarea/README.md +0 -15
  27. package/src/input/Toggle/README.md +0 -15
  28. package/src/layout/Box/README.md +0 -15
  29. package/src/layout/Sidebar/README.md +0 -109
  30. package/src/navigation/Breadcrumb/README.md +0 -56
  31. package/src/navigation/Link/README.md +0 -15
  32. package/src/navigation/Pagination/README.md +0 -15
  33. package/src/navigation/SideNavigation/README.md +0 -87
  34. package/src/navigation/Tabs/README.md +0 -9
  35. package/src/stylization/ThemeProvider/README.md +0 -56
  36. package/src/surface/Accordion/README.md +0 -93
  37. package/src/surface/Banner/README.md +0 -15
  38. package/src/surface/Card/README.md +0 -15
  39. package/src/surface/Modal/README.md +0 -15
  40. package/src/types/README.md +0 -73
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rarui/components",
3
- "version": "1.30.0",
3
+ "version": "1.30.2",
4
4
  "license": "MIT",
5
5
  "main": "dist/index.js",
6
6
  "type": "module",
@@ -1,15 +0,0 @@
1
- # `@rarui/avatar`
2
-
3
- The Avatar component is typically used to display user profile pictures.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/avatar
9
- # or
10
- $ npm install @rarui/avatar
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/text`
2
-
3
- Text is a basic component that allows us to write blocks of text and give it formatting to use within other components, sections and pages of our application or website.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/text
9
- # or
10
- $ npm install @rarui/text
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/divider`
2
-
3
- A Divider is a thin line used to separate or group content into lists and layouts.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/divider
9
- # or
10
- $ npm install @rarui/divider
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/icon`
2
-
3
- Icons are used to visually communicate core parts of the product and available actions. They can act as wayfinding tools to help merchants more easily understand where they are in the product, and common interaction patterns that are available.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/icon
9
- # or
10
- $ npm install @rarui/icon
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/label`
2
-
3
- The label component allows us to name elements within a form.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/label
9
- # or
10
- $ npm install @rarui/label
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/stepper`
2
-
3
- The Stepper component facilitates the sequential navigation of multi-step forms by visually representing each step's progression.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/stepper
9
- # or
10
- $ npm install @rarui/stepper
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/text`
2
-
3
- Text is a basic component that allows us to write blocks of text and give it formatting to use within other components, sections and pages of our application or website.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/text
9
- # or
10
- $ npm install @rarui/text
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/title`
2
-
3
- Tilte is a basic component that allows you to give titles and more hierarchy to blocks of text for sections or header components.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/title
9
- # or
10
- $ npm install @rarui/title
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/tooltip`
2
-
3
- Tooltip are informative, specific, and action -oriented text labels that provide contextual support.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/tooltip
9
- # or
10
- $ npm install @rarui/tooltip
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/progress`
2
-
3
- Progress indicators express an unspecified waiting time or display the duration of a process.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/progress
9
- # or
10
- $ npm install @rarui/progress
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/skeleton`
2
-
3
- The Skeleton component allows us to visually communicate the loading of other components.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/skeleton
9
- # or
10
- $ npm install @rarui/skeleton
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/status`
2
-
3
- Status are used to indicate the current state of a process.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/status
9
- # or
10
- $ npm install @rarui/status
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/button`
2
-
3
- The Button component allows us to initiate actions, make state or page changes.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/button
9
- # or
10
- $ npm install @rarui/button
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/checkbox`
2
-
3
- The Checkbox allows users to select one or more items from a set and can be used to enable or disable an option.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/checkbox
9
- # or
10
- $ npm install @rarui/checkbox
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/chip`
2
-
3
- Chip is a small component used to make selections, filter content, or trigger actions.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/chip
9
- # or
10
- $ npm install @rarui/chip
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/dropdown`
2
-
3
- Dropdown are informative, specific, and action -oriented text labels that provide contextual support.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/dropdown
9
- # or
10
- $ npm install @rarui/dropdown
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/icon-button`
2
-
3
- The IconButton component allows us to initiate actions, make state or page changes.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/icon-button
9
- # or
10
- $ npm install @rarui/icon-button
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,44 +0,0 @@
1
- # `@rarui/input`
2
-
3
- The Input component provides text input functionality with support for leading elements, different sizes, appearances, and specialized variants like password and search inputs.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/input
9
- # or
10
- $ npm install @rarui/input
11
- ```
12
-
13
- ## Usage
14
-
15
- ### Basic Input
16
- ```html
17
- <rarui-input placeholder="Digite seu nome"></rarui-input>
18
- ```
19
-
20
- ### Input with Leading Elements
21
- ```html
22
- <rarui-input placeholder="Digite seu nome">
23
- <rarui-icon slot="leading-start" name="user_filled"></rarui-icon>
24
- <rarui-icon slot="leading-end" name="check"></rarui-icon>
25
- </rarui-input>
26
- ```
27
-
28
- ### Password Input
29
- ```html
30
- <rarui-input-password placeholder="Digite sua senha"></rarui-input-password>
31
- ```
32
-
33
- ### Search Input
34
- ```html
35
- <rarui-input-search placeholder="Buscar..."></rarui-input-search>
36
- ```
37
-
38
- ## Components
39
-
40
- - `rarui-input` - Base input component with slot support
41
- - `rarui-input-password` - Password input with show/hide toggle
42
- - `rarui-input-search` - Search input with built-in search icon
43
-
44
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/radio-button`
2
-
3
- The Radio Button allows users to select an option from a set. They are a selection control that usually appears when users are asked to make decisions or select an option from options.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/radio-button
9
- # or
10
- $ npm install @rarui/radio-button
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,13 +0,0 @@
1
- # Select
2
-
3
- Select component for choosing options from a dropdown menu with support for single and multiple selection.
4
-
5
- ## Features
6
-
7
- - **Single Selection**: Choose one option from the list
8
- - **Multiple Selection**: Choose multiple options with checkboxes
9
- - **Custom Content**: Support for slot-based custom content and filtering
10
- - **Accessibility**: Full keyboard navigation with ESC key support
11
- - **Controlled Behavior**: Uses internal web components (Dropdown, Checkbox, Text, Box, Chip, Icon)
12
-
13
- See [complete documentation](https://rarui.rarolabs.com.br/docs/components-web-components/input/select) for more details.
@@ -1,15 +0,0 @@
1
- # `@rarui/textarea`
2
-
3
- Textarea is a basic component that allows us to write blocks of text and give it formatting to use within other components, sections and pages of our application or website.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/textarea
9
- # or
10
- $ npm install @rarui/textarea
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/toggle`
2
-
3
- Toggle switches enable or disable the state of a single item.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/toggle
9
- # or
10
- $ npm install @rarui/toggle
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/box`
2
-
3
- A low-level utility component that accepts styled system props to enable custom theme-aware styling
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/box
9
- # or
10
- $ npm install @rarui/box
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,109 +0,0 @@
1
- # Rarui Sidebar
2
-
3
- A sidebar component that slides in from the left or right side of the screen, with intelligent positioning for responsive behavior.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- npm install @rarui/sidebar
9
- # or
10
- yarn add @rarui/sidebar
11
- ```
12
-
13
- ## Usage
14
-
15
- ```html
16
- <rarui-sidebar open="true" position="right" max-width="375px" padding="$small">
17
- <div>Your sidebar content here</div>
18
- </rarui-sidebar>
19
- ```
20
-
21
- ## Features
22
-
23
- - ✨ **Floating-UI Integration**: Intelligent positioning with automatic viewport adjustments using floating-ui
24
- - 📱 **Responsive**: Adapts to different screen sizes automatically
25
- - 🎭 **CSS Transitions**: Smooth slide animations with proper transition support
26
- - ♿ **Accessible**: Full keyboard navigation and screen reader support
27
- - 🎯 **Position Control**: Left or right positioning options
28
- - 🔒 **Focus Management**: Automatic focus trapping and restoration
29
- - 🎨 **Themeable**: Works with Rarui design tokens
30
-
31
- ## Properties
32
-
33
- | Property | Type | Default | Description |
34
- |----------|------|---------|-------------|
35
- | `open` | `boolean` | `false` | Whether the sidebar is open or not |
36
- | `position` | `'left' \| 'right'` | `'right'` | The position of the sidebar |
37
- | `max-width` | `string` | `'375px'` | Maximum width of the sidebar |
38
- | `padding` | `string` | `'$small'` | Padding inside the sidebar |
39
- | `portal-id` | `string` | - | ID of the portal element for rendering |
40
-
41
- > **Note**: Properties inherit from `SidebarProps` and are automatically converted from camelCase to kebab-case for web component attributes (e.g., `maxWidth` → `max-width`, `portalId` → `portal-id`).
42
-
43
- ## Events
44
-
45
- | Event | Detail | Description |
46
- |-------|--------|-------------|
47
- | `sidebar-open-changed` | `{ open: boolean }` | Dispatched when the sidebar open state changes |
48
-
49
- ## Examples
50
-
51
- ### Basic Sidebar
52
-
53
- ```html
54
- <rarui-sidebar open="true">
55
- <div>Basic sidebar content</div>
56
- </rarui-sidebar>
57
- ```
58
-
59
- ### Left Positioned Sidebar
60
-
61
- ```html
62
- <rarui-sidebar open="true" position="left" max-width="300px">
63
- <nav>
64
- <ul>
65
- <li>Home</li>
66
- <li>About</li>
67
- <li>Contact</li>
68
- </ul>
69
- </nav>
70
- </rarui-sidebar>
71
- ```
72
-
73
- ### Custom Width and Padding
74
-
75
- ```html
76
- <rarui-sidebar open="true" max-width="500px" padding="$large">
77
- <div>Wide sidebar with custom padding</div>
78
- </rarui-sidebar>
79
- ```
80
-
81
- ## Differences from React Version
82
-
83
- ### Enhanced Features
84
- - **Floating-UI Integration**: Unlike the React version that uses basic floating-ui hooks, the web component version uses advanced virtual references for optimal sidebar positioning
85
- - **Smooth Transitions**: Always renders allowing CSS transitions to work properly
86
- - **Automatic Viewport Adaptation**: Content automatically adjusts to viewport constraints using floating-ui middleware
87
- - **Better Performance**: Native web APIs with optimized floating-ui integration
88
-
89
- ### Positioning Intelligence
90
- The web component version provides superior positioning capabilities:
91
- - Virtual reference system optimized for sidebar edges
92
- - Responsive width adjustments via floating-ui size middleware
93
- - Intelligent overflow prevention with shift middleware
94
- - Automatic repositioning on viewport changes
95
-
96
- ## Browser Support
97
-
98
- This component works in all modern browsers that support:
99
- - Web Components
100
- - ES2017+ features
101
- - CSS Custom Properties
102
-
103
- ## Development
104
-
105
- Built with:
106
- - **LitElement** for the component base
107
- - **Floating-UI** for advanced positioning with virtual references
108
- - **TypeScript** for type safety
109
- - **Rarui Design System** for styling
@@ -1,56 +0,0 @@
1
- # Breadcrumb
2
-
3
- O componente Breadcrumb permite a navegação hierárquica através de uma estrutura de páginas, indicando a localização atual do usuário e fornecendo links para as páginas anteriores.
4
-
5
- ## Quando usar
6
-
7
- - Para mostrar a localização atual do usuário na hierarquia do site
8
- - Para permitir navegação rápida para níveis anteriores da estrutura
9
- - Em sistemas com estrutura hierárquica profunda (mais de 3 níveis)
10
-
11
- ## Estrutura
12
-
13
- O componente é formado por:
14
-
15
- - `rarui-breadcrumb`: Container principal que gerencia a lógica de truncamento
16
- - `rarui-breadcrumb-item`: Item individual do breadcrumb
17
-
18
- ## Uso básico
19
-
20
- ```html
21
- <rarui-breadcrumb>
22
- <rarui-breadcrumb-item href="/">Home</rarui-breadcrumb-item>
23
- <rarui-breadcrumb-item href="/category">Category</rarui-breadcrumb-item>
24
- <rarui-breadcrumb-item href="/subcategory">Subcategory</rarui-breadcrumb-item>
25
- <rarui-breadcrumb-item active>Current Page</rarui-breadcrumb-item>
26
- </rarui-breadcrumb>
27
- ```
28
-
29
- ## Com truncamento
30
-
31
- ```html
32
- <rarui-breadcrumb items-after-truncate="2">
33
- <rarui-breadcrumb-item href="/">Home</rarui-breadcrumb-item>
34
- <rarui-breadcrumb-item href="/level1">Level 1</rarui-breadcrumb-item>
35
- <rarui-breadcrumb-item href="/level2">Level 2</rarui-breadcrumb-item>
36
- <rarui-breadcrumb-item href="/level3">Level 3</rarui-breadcrumb-item>
37
- <rarui-breadcrumb-item href="/level4">Level 4</rarui-breadcrumb-item>
38
- <rarui-breadcrumb-item active>Current</rarui-breadcrumb-item>
39
- </rarui-breadcrumb>
40
- ```
41
-
42
- ## Com ícones
43
-
44
- ```html
45
- <rarui-breadcrumb>
46
- <rarui-breadcrumb-item href="/">
47
- <rarui-icon slot="icon" name="home"></rarui-icon>
48
- Home
49
- </rarui-breadcrumb-item>
50
- <rarui-breadcrumb-item href="/dashboard">
51
- <rarui-icon slot="icon" name="dashboard"></rarui-icon>
52
- Dashboard
53
- </rarui-breadcrumb-item>
54
- <rarui-breadcrumb-item active>Settings</rarui-breadcrumb-item>
55
- </rarui-breadcrumb>
56
- ```
@@ -1,15 +0,0 @@
1
- # `@rarui/link`
2
-
3
- The Link component allows us to navigate to external addresses.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/link
9
- # or
10
- $ npm install @rarui/link
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().
@@ -1,15 +0,0 @@
1
- # `@rarui/pagination`
2
-
3
- The pagination component allows the user to select a specific page in a page range.
4
-
5
- ## Installation
6
-
7
- ```sh
8
- $ yarn add @rarui/pagination
9
- # or
10
- $ npm install @rarui/pagination
11
- ```
12
-
13
- ## Usage
14
-
15
- View docs [here]().