@edsis/ui 0.0.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.
- package/README.md +40 -0
- package/accordion/README.md +195 -0
- package/alert/README.md +177 -0
- package/alert-dialog/README.md +239 -0
- package/aspect-ratio/README.md +112 -0
- package/avatar/README.md +176 -0
- package/badge/README.md +133 -0
- package/breadcrumb/README.md +216 -0
- package/button/README.md +139 -0
- package/button-group/README.md +204 -0
- package/calendar/README.md +132 -0
- package/card/README.md +220 -0
- package/carousel/README.md +276 -0
- package/chart/README.md +249 -0
- package/checkbox/README.md +149 -0
- package/collapsible/README.md +191 -0
- package/combobox/README.md +198 -0
- package/command/README.md +275 -0
- package/composer/README.md +235 -0
- package/context-menu/README.md +267 -0
- package/date-picker/README.md +177 -0
- package/dialog/README.md +237 -0
- package/drawer/README.md +145 -0
- package/dropdown-menu/README.md +311 -0
- package/editor/README.md +136 -0
- package/empty/README.md +183 -0
- package/fesm2022/edsis-ui-accordion.mjs +174 -0
- package/fesm2022/edsis-ui-accordion.mjs.map +1 -0
- package/fesm2022/edsis-ui-alert-dialog.mjs +242 -0
- package/fesm2022/edsis-ui-alert-dialog.mjs.map +1 -0
- package/fesm2022/edsis-ui-alert.mjs +90 -0
- package/fesm2022/edsis-ui-alert.mjs.map +1 -0
- package/fesm2022/edsis-ui-aspect-ratio.mjs +33 -0
- package/fesm2022/edsis-ui-aspect-ratio.mjs.map +1 -0
- package/fesm2022/edsis-ui-avatar.mjs +123 -0
- package/fesm2022/edsis-ui-avatar.mjs.map +1 -0
- package/fesm2022/edsis-ui-badge.mjs +47 -0
- package/fesm2022/edsis-ui-badge.mjs.map +1 -0
- package/fesm2022/edsis-ui-breadcrumb.mjs +186 -0
- package/fesm2022/edsis-ui-breadcrumb.mjs.map +1 -0
- package/fesm2022/edsis-ui-button-group.mjs +95 -0
- package/fesm2022/edsis-ui-button-group.mjs.map +1 -0
- package/fesm2022/edsis-ui-button.mjs +64 -0
- package/fesm2022/edsis-ui-button.mjs.map +1 -0
- package/fesm2022/edsis-ui-calendar.mjs +78 -0
- package/fesm2022/edsis-ui-calendar.mjs.map +1 -0
- package/fesm2022/edsis-ui-card.mjs +137 -0
- package/fesm2022/edsis-ui-card.mjs.map +1 -0
- package/fesm2022/edsis-ui-carousel.mjs +310 -0
- package/fesm2022/edsis-ui-carousel.mjs.map +1 -0
- package/fesm2022/edsis-ui-chart-area.mjs +6 -0
- package/fesm2022/edsis-ui-chart-area.mjs.map +1 -0
- package/fesm2022/edsis-ui-chart-bar.mjs +6 -0
- package/fesm2022/edsis-ui-chart-bar.mjs.map +1 -0
- package/fesm2022/edsis-ui-chart-line.mjs +6 -0
- package/fesm2022/edsis-ui-chart-line.mjs.map +1 -0
- package/fesm2022/edsis-ui-chart-pie.mjs +6 -0
- package/fesm2022/edsis-ui-chart-pie.mjs.map +1 -0
- package/fesm2022/edsis-ui-chart-radar.mjs +6 -0
- package/fesm2022/edsis-ui-chart-radar.mjs.map +1 -0
- package/fesm2022/edsis-ui-chart-radial.mjs +6 -0
- package/fesm2022/edsis-ui-chart-radial.mjs.map +1 -0
- package/fesm2022/edsis-ui-chart-scatter.mjs +6 -0
- package/fesm2022/edsis-ui-chart-scatter.mjs.map +1 -0
- package/fesm2022/edsis-ui-chart.mjs +3714 -0
- package/fesm2022/edsis-ui-chart.mjs.map +1 -0
- package/fesm2022/edsis-ui-checkbox.mjs +104 -0
- package/fesm2022/edsis-ui-checkbox.mjs.map +1 -0
- package/fesm2022/edsis-ui-collapsible.mjs +116 -0
- package/fesm2022/edsis-ui-collapsible.mjs.map +1 -0
- package/fesm2022/edsis-ui-combobox.mjs +263 -0
- package/fesm2022/edsis-ui-combobox.mjs.map +1 -0
- package/fesm2022/edsis-ui-command.mjs +268 -0
- package/fesm2022/edsis-ui-command.mjs.map +1 -0
- package/fesm2022/edsis-ui-composer.mjs +329 -0
- package/fesm2022/edsis-ui-composer.mjs.map +1 -0
- package/fesm2022/edsis-ui-context-menu.mjs +100 -0
- package/fesm2022/edsis-ui-context-menu.mjs.map +1 -0
- package/fesm2022/edsis-ui-date-picker.mjs +155 -0
- package/fesm2022/edsis-ui-date-picker.mjs.map +1 -0
- package/fesm2022/edsis-ui-dialog.mjs +262 -0
- package/fesm2022/edsis-ui-dialog.mjs.map +1 -0
- package/fesm2022/edsis-ui-drawer.mjs +6 -0
- package/fesm2022/edsis-ui-drawer.mjs.map +1 -0
- package/fesm2022/edsis-ui-dropdown-menu.mjs +466 -0
- package/fesm2022/edsis-ui-dropdown-menu.mjs.map +1 -0
- package/fesm2022/edsis-ui-editor.mjs +692 -0
- package/fesm2022/edsis-ui-editor.mjs.map +1 -0
- package/fesm2022/edsis-ui-empty.mjs +132 -0
- package/fesm2022/edsis-ui-empty.mjs.map +1 -0
- package/fesm2022/edsis-ui-form.mjs +334 -0
- package/fesm2022/edsis-ui-form.mjs.map +1 -0
- package/fesm2022/edsis-ui-hover-card.mjs +284 -0
- package/fesm2022/edsis-ui-hover-card.mjs.map +1 -0
- package/fesm2022/edsis-ui-input-group.mjs +164 -0
- package/fesm2022/edsis-ui-input-group.mjs.map +1 -0
- package/fesm2022/edsis-ui-input-otp.mjs +485 -0
- package/fesm2022/edsis-ui-input-otp.mjs.map +1 -0
- package/fesm2022/edsis-ui-input.mjs +43 -0
- package/fesm2022/edsis-ui-input.mjs.map +1 -0
- package/fesm2022/edsis-ui-item.mjs +241 -0
- package/fesm2022/edsis-ui-item.mjs.map +1 -0
- package/fesm2022/edsis-ui-kanban.mjs +289 -0
- package/fesm2022/edsis-ui-kanban.mjs.map +1 -0
- package/fesm2022/edsis-ui-kbd.mjs +51 -0
- package/fesm2022/edsis-ui-kbd.mjs.map +1 -0
- package/fesm2022/edsis-ui-label.mjs +30 -0
- package/fesm2022/edsis-ui-label.mjs.map +1 -0
- package/fesm2022/edsis-ui-menubar.mjs +302 -0
- package/fesm2022/edsis-ui-menubar.mjs.map +1 -0
- package/fesm2022/edsis-ui-native-select.mjs +61 -0
- package/fesm2022/edsis-ui-native-select.mjs.map +1 -0
- package/fesm2022/edsis-ui-navigation-menu.mjs +399 -0
- package/fesm2022/edsis-ui-navigation-menu.mjs.map +1 -0
- package/fesm2022/edsis-ui-pagination.mjs +216 -0
- package/fesm2022/edsis-ui-pagination.mjs.map +1 -0
- package/fesm2022/edsis-ui-pillbox.mjs +777 -0
- package/fesm2022/edsis-ui-pillbox.mjs.map +1 -0
- package/fesm2022/edsis-ui-popover.mjs +163 -0
- package/fesm2022/edsis-ui-popover.mjs.map +1 -0
- package/fesm2022/edsis-ui-progress.mjs +53 -0
- package/fesm2022/edsis-ui-progress.mjs.map +1 -0
- package/fesm2022/edsis-ui-radio.mjs +111 -0
- package/fesm2022/edsis-ui-radio.mjs.map +1 -0
- package/fesm2022/edsis-ui-resizable.mjs +454 -0
- package/fesm2022/edsis-ui-resizable.mjs.map +1 -0
- package/fesm2022/edsis-ui-scroll-area.mjs +48 -0
- package/fesm2022/edsis-ui-scroll-area.mjs.map +1 -0
- package/fesm2022/edsis-ui-select.mjs +164 -0
- package/fesm2022/edsis-ui-select.mjs.map +1 -0
- package/fesm2022/edsis-ui-separator.mjs +33 -0
- package/fesm2022/edsis-ui-separator.mjs.map +1 -0
- package/fesm2022/edsis-ui-sheet.mjs +264 -0
- package/fesm2022/edsis-ui-sheet.mjs.map +1 -0
- package/fesm2022/edsis-ui-skeleton.mjs +29 -0
- package/fesm2022/edsis-ui-skeleton.mjs.map +1 -0
- package/fesm2022/edsis-ui-slider.mjs +405 -0
- package/fesm2022/edsis-ui-slider.mjs.map +1 -0
- package/fesm2022/edsis-ui-spinner.mjs +58 -0
- package/fesm2022/edsis-ui-spinner.mjs.map +1 -0
- package/fesm2022/edsis-ui-switch.mjs +107 -0
- package/fesm2022/edsis-ui-switch.mjs.map +1 -0
- package/fesm2022/edsis-ui-table.mjs +139 -0
- package/fesm2022/edsis-ui-table.mjs.map +1 -0
- package/fesm2022/edsis-ui-tabs.mjs +252 -0
- package/fesm2022/edsis-ui-tabs.mjs.map +1 -0
- package/fesm2022/edsis-ui-textarea.mjs +37 -0
- package/fesm2022/edsis-ui-textarea.mjs.map +1 -0
- package/fesm2022/edsis-ui-timeline.mjs +213 -0
- package/fesm2022/edsis-ui-timeline.mjs.map +1 -0
- package/fesm2022/edsis-ui-toast.mjs +71 -0
- package/fesm2022/edsis-ui-toast.mjs.map +1 -0
- package/fesm2022/edsis-ui-toggle-group.mjs +269 -0
- package/fesm2022/edsis-ui-toggle-group.mjs.map +1 -0
- package/fesm2022/edsis-ui-toggle.mjs +76 -0
- package/fesm2022/edsis-ui-toggle.mjs.map +1 -0
- package/fesm2022/edsis-ui-tooltip.mjs +339 -0
- package/fesm2022/edsis-ui-tooltip.mjs.map +1 -0
- package/fesm2022/edsis-ui-utils.mjs +13 -0
- package/fesm2022/edsis-ui-utils.mjs.map +1 -0
- package/fesm2022/edsis-ui.mjs +11 -0
- package/fesm2022/edsis-ui.mjs.map +1 -0
- package/form/README.md +210 -0
- package/hover-card/README.md +146 -0
- package/input/README.md +159 -0
- package/input-group/README.md +234 -0
- package/input-otp/README.md +273 -0
- package/item/README.md +247 -0
- package/kanban/README.md +81 -0
- package/kbd/README.md +139 -0
- package/label/README.md +136 -0
- package/menubar/README.md +269 -0
- package/native-select/README.md +176 -0
- package/navigation-menu/README.md +160 -0
- package/package.json +310 -0
- package/pagination/README.md +144 -0
- package/pillbox/README.md +67 -0
- package/popover/README.md +43 -0
- package/progress/README.md +160 -0
- package/radio/README.md +209 -0
- package/resizable/README.md +164 -0
- package/scroll-area/README.md +143 -0
- package/select/README.md +174 -0
- package/separator/README.md +170 -0
- package/sheet/README.md +183 -0
- package/skeleton/README.md +158 -0
- package/slider/README.md +207 -0
- package/spinner/README.md +160 -0
- package/switch/README.md +166 -0
- package/table/README.md +291 -0
- package/tabs/README.md +214 -0
- package/textarea/README.md +154 -0
- package/timeline/README.md +94 -0
- package/toast/README.md +321 -0
- package/toggle/README.md +131 -0
- package/toggle-group/README.md +206 -0
- package/tooltip/README.md +211 -0
- package/types/edsis-ui-accordion.d.ts +51 -0
- package/types/edsis-ui-alert-dialog.d.ts +93 -0
- package/types/edsis-ui-alert.d.ts +37 -0
- package/types/edsis-ui-aspect-ratio.d.ts +12 -0
- package/types/edsis-ui-avatar.d.ts +51 -0
- package/types/edsis-ui-badge.d.ts +19 -0
- package/types/edsis-ui-breadcrumb.d.ts +46 -0
- package/types/edsis-ui-button-group.d.ts +26 -0
- package/types/edsis-ui-button.d.ts +22 -0
- package/types/edsis-ui-calendar.d.ts +33 -0
- package/types/edsis-ui-card.d.ts +60 -0
- package/types/edsis-ui-carousel.d.ts +86 -0
- package/types/edsis-ui-chart-area.d.ts +1 -0
- package/types/edsis-ui-chart-bar.d.ts +1 -0
- package/types/edsis-ui-chart-line.d.ts +1 -0
- package/types/edsis-ui-chart-pie.d.ts +1 -0
- package/types/edsis-ui-chart-radar.d.ts +1 -0
- package/types/edsis-ui-chart-radial.d.ts +1 -0
- package/types/edsis-ui-chart-scatter.d.ts +1 -0
- package/types/edsis-ui-chart.d.ts +1094 -0
- package/types/edsis-ui-checkbox.d.ts +35 -0
- package/types/edsis-ui-collapsible.d.ts +42 -0
- package/types/edsis-ui-combobox.d.ts +51 -0
- package/types/edsis-ui-command.d.ts +99 -0
- package/types/edsis-ui-composer.d.ts +90 -0
- package/types/edsis-ui-context-menu.d.ts +35 -0
- package/types/edsis-ui-date-picker.d.ts +41 -0
- package/types/edsis-ui-dialog.d.ts +87 -0
- package/types/edsis-ui-drawer.d.ts +1 -0
- package/types/edsis-ui-dropdown-menu.d.ts +136 -0
- package/types/edsis-ui-editor.d.ts +123 -0
- package/types/edsis-ui-empty.d.ts +50 -0
- package/types/edsis-ui-form.d.ts +141 -0
- package/types/edsis-ui-hover-card.d.ts +74 -0
- package/types/edsis-ui-input-group.d.ts +51 -0
- package/types/edsis-ui-input-otp.d.ts +136 -0
- package/types/edsis-ui-input.d.ts +16 -0
- package/types/edsis-ui-item.d.ts +88 -0
- package/types/edsis-ui-kanban.d.ts +70 -0
- package/types/edsis-ui-kbd.d.ts +16 -0
- package/types/edsis-ui-label.d.ts +11 -0
- package/types/edsis-ui-menubar.d.ts +67 -0
- package/types/edsis-ui-native-select.d.ts +26 -0
- package/types/edsis-ui-navigation-menu.d.ts +96 -0
- package/types/edsis-ui-pagination.d.ts +34 -0
- package/types/edsis-ui-pillbox.d.ts +157 -0
- package/types/edsis-ui-popover.d.ts +43 -0
- package/types/edsis-ui-progress.d.ts +17 -0
- package/types/edsis-ui-radio.d.ts +40 -0
- package/types/edsis-ui-resizable.d.ts +99 -0
- package/types/edsis-ui-scroll-area.d.ts +19 -0
- package/types/edsis-ui-select.d.ts +57 -0
- package/types/edsis-ui-separator.d.ts +14 -0
- package/types/edsis-ui-sheet.d.ts +76 -0
- package/types/edsis-ui-skeleton.d.ts +10 -0
- package/types/edsis-ui-slider.d.ts +74 -0
- package/types/edsis-ui-spinner.d.ts +13 -0
- package/types/edsis-ui-switch.d.ts +40 -0
- package/types/edsis-ui-table.d.ts +52 -0
- package/types/edsis-ui-tabs.d.ts +92 -0
- package/types/edsis-ui-textarea.d.ts +12 -0
- package/types/edsis-ui-timeline.d.ts +63 -0
- package/types/edsis-ui-toast.d.ts +38 -0
- package/types/edsis-ui-toggle-group.d.ts +89 -0
- package/types/edsis-ui-toggle.d.ts +25 -0
- package/types/edsis-ui-tooltip.d.ts +89 -0
- package/types/edsis-ui-utils.d.ts +5 -0
- package/types/edsis-ui.d.ts +2 -0
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# Pagination
|
|
2
|
+
|
|
3
|
+
Compact page navigation with previous and next controls, windowed page numbers, optional icon-only mode, and localized labels.
|
|
4
|
+
|
|
5
|
+
Use Pagination when a feature page needs to move through a paged API result, a dense table footer, or a navigable list of routes or guides.
|
|
6
|
+
|
|
7
|
+
## Import
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { PaginationComponent } from '@edsis/ui/pagination';
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Structure
|
|
14
|
+
|
|
15
|
+
The Angular package intentionally wraps the shadcn multi-part composition in a single standalone primitive.
|
|
16
|
+
|
|
17
|
+
```text
|
|
18
|
+
ui-pagination
|
|
19
|
+
├── previous button
|
|
20
|
+
├── page buttons and ellipsis
|
|
21
|
+
└── next button
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Basic usage
|
|
25
|
+
|
|
26
|
+
Bind `[(page)]` to a signal and keep your collection, router state, or server request outside the primitive.
|
|
27
|
+
|
|
28
|
+
```html
|
|
29
|
+
<ui-pagination [(page)]="currentPage" [total]="totalPages" [siblingCount]="1" (pageChange)="load($event)" />
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Common patterns
|
|
33
|
+
|
|
34
|
+
### Navigation data
|
|
35
|
+
|
|
36
|
+
Keep the rendered collection in sync with the pager through `computed()`.
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
const navigationPage = signal(1);
|
|
40
|
+
const pageSize = 4;
|
|
41
|
+
|
|
42
|
+
const navigationItems = [
|
|
43
|
+
{ title: 'Introduction', route: '/docs/introduction' },
|
|
44
|
+
{ title: 'Accordion', route: '/ui/shadcn/accordion' },
|
|
45
|
+
{ title: 'Button', route: '/ui/shadcn/button' },
|
|
46
|
+
{ title: 'Input', route: '/ui/shadcn/input' },
|
|
47
|
+
// ...more items
|
|
48
|
+
];
|
|
49
|
+
|
|
50
|
+
const totalPages = Math.ceil(navigationItems.length / pageSize);
|
|
51
|
+
const visibleItems = computed(() => {
|
|
52
|
+
const start = (navigationPage() - 1) * pageSize;
|
|
53
|
+
return navigationItems.slice(start, start + pageSize);
|
|
54
|
+
});
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Icons only
|
|
58
|
+
|
|
59
|
+
Hide page numbers and visible labels when the pager sits next to a dense table or feed footer.
|
|
60
|
+
|
|
61
|
+
```html
|
|
62
|
+
<ui-pagination
|
|
63
|
+
[(page)]="compactPage"
|
|
64
|
+
[total]="9"
|
|
65
|
+
[showPageNumbers]="false"
|
|
66
|
+
previousText=""
|
|
67
|
+
nextText=""
|
|
68
|
+
class="mx-0 w-auto" />
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### RTL and translated labels
|
|
72
|
+
|
|
73
|
+
Translate the previous and next text and provide a page formatter when locale-specific numerals should appear.
|
|
74
|
+
|
|
75
|
+
```ts
|
|
76
|
+
const arabicDigits = ['٠', '١', '٢', '٣', '٤', '٥', '٦', '٧', '٨', '٩'];
|
|
77
|
+
const toArabicNumerals = (page: number): string =>
|
|
78
|
+
page
|
|
79
|
+
.toString()
|
|
80
|
+
.split('')
|
|
81
|
+
.map((digit) => arabicDigits[Number(digit)] ?? digit)
|
|
82
|
+
.join('');
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
```html
|
|
86
|
+
<section dir="rtl" lang="ar" class="text-right">
|
|
87
|
+
<ui-pagination
|
|
88
|
+
[(page)]="rtlPage"
|
|
89
|
+
[total]="7"
|
|
90
|
+
previousText="السابق"
|
|
91
|
+
nextText="التالي"
|
|
92
|
+
previousAriaLabel="الانتقال إلى الصفحة السابقة"
|
|
93
|
+
nextAriaLabel="الانتقال إلى الصفحة التالية"
|
|
94
|
+
[formatPageLabel]="toArabicNumerals" />
|
|
95
|
+
</section>
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## API reference
|
|
99
|
+
|
|
100
|
+
| Input | Type | Default | Description |
|
|
101
|
+
| ------------------- | -------------------------- | ------------------------- | ---------------------------------------------------------------------- |
|
|
102
|
+
| `page` (model) | `number` | `1` | Two-way bound current page. |
|
|
103
|
+
| `total` | `number` | `1` | Total number of pages available. |
|
|
104
|
+
| `siblingCount` | `number` | `1` | Page buttons shown on either side of the active page. |
|
|
105
|
+
| `showPageNumbers` | `boolean` | `true` | Hide numbered page buttons for compact previous and next only layouts. |
|
|
106
|
+
| `previousText` | `string` | `'Previous'` | Visible previous label. Set to an empty string for icon-only mode. |
|
|
107
|
+
| `nextText` | `string` | `'Next'` | Visible next label. Set to an empty string for icon-only mode. |
|
|
108
|
+
| `previousAriaLabel` | `string` | `'Go to previous page'` | Accessible name for the previous button. |
|
|
109
|
+
| `nextAriaLabel` | `string` | `'Go to next page'` | Accessible name for the next button. |
|
|
110
|
+
| `formatPageLabel` | `(page: number) => string` | `page => page.toString()` | Formats the rendered page label. |
|
|
111
|
+
| `class` | `string` | `''` | Extra container classes. |
|
|
112
|
+
|
|
113
|
+
| Output | Payload | Description |
|
|
114
|
+
| ------------ | -------- | ---------------------------------------------------- |
|
|
115
|
+
| `pageChange` | `number` | Emits the next page number after a user interaction. |
|
|
116
|
+
|
|
117
|
+
## Styling and theming
|
|
118
|
+
|
|
119
|
+
Pagination reuses `buttonVariants`, so the previous and next controls plus numbered page buttons inherit the same shape, focus ring, and theme tokens as the Button primitive.
|
|
120
|
+
|
|
121
|
+
Pass `class` to adjust width and alignment, for example `mx-0 w-auto` in a table footer or `justify-start` when the pager should align to the left edge of a card.
|
|
122
|
+
|
|
123
|
+
## Accessibility
|
|
124
|
+
|
|
125
|
+
- The root renders as `<nav role="navigation" aria-label="pagination">`.
|
|
126
|
+
- The active page is marked with `aria-current="page"`.
|
|
127
|
+
- Previous and next disable natively at the start and end of the available range.
|
|
128
|
+
- Ellipses are `aria-hidden="true"`.
|
|
129
|
+
- When visible text is removed for icon-only mode, keep meaningful aria labels on the previous and next buttons.
|
|
130
|
+
|
|
131
|
+
## Keyboard interactions
|
|
132
|
+
|
|
133
|
+
- Tab moves focus through the previous button, page buttons, and next button in DOM order.
|
|
134
|
+
- Enter and Space activate the focused button through native button semantics.
|
|
135
|
+
|
|
136
|
+
## Angular notes
|
|
137
|
+
|
|
138
|
+
- Keep the paged collection outside the component and derive the visible slice with `computed()`.
|
|
139
|
+
- Import `PaginationComponent` into the standalone feature component that renders the pager.
|
|
140
|
+
- `showPageNumbers`, `previousText`, `nextText`, and `formatPageLabel` are deliberate Angular-specific conveniences that cover the upstream icon-only and RTL guidance without exposing React-style child parts.
|
|
141
|
+
|
|
142
|
+
## Source parity
|
|
143
|
+
|
|
144
|
+
shadcn documents Pagination as several composable parts such as `PaginationLink`, `PaginationPrevious`, and `PaginationNext`. This Angular implementation intentionally collapses that structure into one primitive so route-driven and data-driven pagination can be wired quickly while still matching the upstream previous, next, ellipsis, compact, and RTL behavior.
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Pillbox
|
|
2
|
+
|
|
3
|
+
Multi-value selection primitives inspired by Flux Pillbox and implemented with local shadcn-style Angular patterns.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import {
|
|
9
|
+
PillboxComponent,
|
|
10
|
+
PillboxOptionComponent,
|
|
11
|
+
PillboxOptionCreateComponent,
|
|
12
|
+
PillboxOptionEmptyComponent,
|
|
13
|
+
PillboxSelectedDirective,
|
|
14
|
+
} from '@edsis/ui/pillbox';
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```html
|
|
20
|
+
<ui-pillbox multiple placeholder="Choose tags..." [(ngModel)]="selectedTags">
|
|
21
|
+
<ui-pillbox-option value="design">Design</ui-pillbox-option>
|
|
22
|
+
<ui-pillbox-option value="development">Development</ui-pillbox-option>
|
|
23
|
+
<ui-pillbox-option value="marketing">Marketing</ui-pillbox-option>
|
|
24
|
+
</ui-pillbox>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Composition
|
|
28
|
+
|
|
29
|
+
- `ui-pillbox` owns the trigger, selected pills, search state, option filtering, and form control integration.
|
|
30
|
+
- `ui-pillbox-option` projects the visible option content and stores the option value.
|
|
31
|
+
- `ng-template[uiPillboxSelected]` customizes the rendered selected pill content for an option.
|
|
32
|
+
- `ui-pillbox-option-create` emits create requests when the search query is long enough and does not match an existing option.
|
|
33
|
+
- `ui-pillbox-option-empty` customizes empty and loading messages.
|
|
34
|
+
|
|
35
|
+
## Inputs
|
|
36
|
+
|
|
37
|
+
### PillboxComponent
|
|
38
|
+
|
|
39
|
+
| Input | Type | Default | Description |
|
|
40
|
+
| ------------------- | ------------------------- | --------------------- | -------------------------------------------------------------------------- |
|
|
41
|
+
| `placeholder` | `string` | `'Choose options...'` | Text shown when nothing is selected. |
|
|
42
|
+
| `searchPlaceholder` | `string` | `'Search...'` | Placeholder for the dropdown search input. |
|
|
43
|
+
| `size` | `'default' \| 'sm'` | `'default'` | Trigger and pill density. |
|
|
44
|
+
| `variant` | `'default' \| 'combobox'` | `'default'` | Use `combobox` to place the search input directly in the trigger. |
|
|
45
|
+
| `multiple` | `boolean` | `false` | Emits an array of selected values when enabled. |
|
|
46
|
+
| `searchable` | `boolean` | `false` | Adds a search input to the dropdown for the default variant. |
|
|
47
|
+
| `filter` | `boolean` | `true` | Enables client-side filtering. Disable it for backend-driven option lists. |
|
|
48
|
+
| `clearable` | `boolean` | `true` | Shows a clear-all control when values are selected. |
|
|
49
|
+
| `disabled` | `boolean` | `false` | Prevents interaction. |
|
|
50
|
+
| `invalid` | `boolean` | `false` | Applies error styling and `aria-invalid`. |
|
|
51
|
+
| `loading` | `boolean` | `false` | Shows loading copy through the empty option when no options match. |
|
|
52
|
+
|
|
53
|
+
## Events
|
|
54
|
+
|
|
55
|
+
| Output | Payload | Description |
|
|
56
|
+
| -------------- | --------- | ------------------------------------------------------------------------- |
|
|
57
|
+
| `valueChange` | `unknown` | Emits the selected array for `multiple` mode or a single value otherwise. |
|
|
58
|
+
| `searchChange` | `string` | Emits whenever the search query changes. |
|
|
59
|
+
| `create` | `string` | Emits the current query from `ui-pillbox-option-create`. |
|
|
60
|
+
| `openedChange` | `boolean` | Emits when the option list opens or closes. |
|
|
61
|
+
|
|
62
|
+
## Accessibility
|
|
63
|
+
|
|
64
|
+
- Use a visible label or `aria-label`/`aria-labelledby` on `ui-pillbox`.
|
|
65
|
+
- Use `multiple` when binding to an array of values.
|
|
66
|
+
- Provide readable option labels; set `label` or `selectedLabel` when custom option content is not textual.
|
|
67
|
+
- Keep create actions explicit and validate new values in the owning form or backend.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Popover
|
|
2
|
+
|
|
3
|
+
Anchored floating panel with CDK overlay. Click the trigger to toggle.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import { PopoverTriggerDirective, PopoverContentDirective } from '@edsis/ui/popover';
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```html
|
|
14
|
+
<button ui-button [uiPopoverTrigger]="content" side="bottom" align="start">Open</button>
|
|
15
|
+
|
|
16
|
+
<ng-template uiPopoverContent #content="uiPopoverContent">
|
|
17
|
+
<div class="w-64 rounded-md border bg-popover p-4 text-popover-foreground shadow-md">Popover body</div>
|
|
18
|
+
</ng-template>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## API
|
|
22
|
+
|
|
23
|
+
### `PopoverTriggerDirective` (`[uiPopoverTrigger]`)
|
|
24
|
+
|
|
25
|
+
| Input | Type | Default |
|
|
26
|
+
| ------------------ | ---------------------------------------- | ---------- |
|
|
27
|
+
| `uiPopoverTrigger` | `PopoverContentDirective` | — |
|
|
28
|
+
| `side` | `'top' \| 'right' \| 'bottom' \| 'left'` | `'bottom'` |
|
|
29
|
+
| `align` | `'start' \| 'center' \| 'end'` | `'center'` |
|
|
30
|
+
| `disabled` | `boolean` | `false` |
|
|
31
|
+
|
|
32
|
+
Exposes `isOpen()` signal. Trigger automatically sets `aria-haspopup="dialog"`
|
|
33
|
+
and `aria-expanded` on the host.
|
|
34
|
+
|
|
35
|
+
### `PopoverContentDirective` (`ng-template[uiPopoverContent]`)
|
|
36
|
+
|
|
37
|
+
Marker directive that exposes the template via `exportAs="uiPopoverContent"`.
|
|
38
|
+
|
|
39
|
+
## Accessibility
|
|
40
|
+
|
|
41
|
+
- Close on `Escape`.
|
|
42
|
+
- Close on backdrop click.
|
|
43
|
+
- Trigger reflects state via `aria-expanded` and `aria-haspopup`.
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# Progress
|
|
2
|
+
|
|
3
|
+
Displays an indicator showing the completion progress of a task, typically as a
|
|
4
|
+
slim passive progress bar.
|
|
5
|
+
|
|
6
|
+
Use Progress for uploads, background jobs, onboarding steps, and other cases
|
|
7
|
+
where the user should understand status without directly interacting with the
|
|
8
|
+
bar itself.
|
|
9
|
+
|
|
10
|
+
## Import
|
|
11
|
+
|
|
12
|
+
```ts
|
|
13
|
+
import { ProgressComponent } from '@edsis/ui/progress';
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
For the visible label and slider-driven examples below, also import the existing
|
|
17
|
+
label and slider entrypoints:
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
import { LabelComponent } from '@edsis/ui/label';
|
|
21
|
+
import { SliderComponent } from '@edsis/ui/slider';
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Basic usage
|
|
25
|
+
|
|
26
|
+
Provide an accessible name directly when the bar stands on its own.
|
|
27
|
+
|
|
28
|
+
```html
|
|
29
|
+
<ui-progress [value]="33" aria-label="Upload progress" class="w-full max-w-sm" />
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Common patterns
|
|
33
|
+
|
|
34
|
+
### Visible label row
|
|
35
|
+
|
|
36
|
+
The current shadcn Radix docs place Progress inside a Field layout with a
|
|
37
|
+
visible label and percentage. In Angular, keep the visible copy outside the
|
|
38
|
+
bar and connect it with `aria-labelledby`.
|
|
39
|
+
|
|
40
|
+
```html
|
|
41
|
+
<ui-label id="progress-upload-label" class="mb-2 flex items-center gap-3">
|
|
42
|
+
<span>Upload progress</span>
|
|
43
|
+
<span class="ms-auto text-muted-foreground">66%</span>
|
|
44
|
+
</ui-label>
|
|
45
|
+
|
|
46
|
+
<ui-progress [value]="66" aria-labelledby="progress-upload-label" class="w-full max-w-sm" />
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Use `aria-labelledby` here instead of `label[for]`, because `ui-progress` is a
|
|
50
|
+
custom element with `role="progressbar"`, not a native labelable form control.
|
|
51
|
+
|
|
52
|
+
### Controlled progress
|
|
53
|
+
|
|
54
|
+
Keep the progress bar passive and let surrounding controls own the interaction.
|
|
55
|
+
The built-in range slider directive works well for the same pattern shown in the
|
|
56
|
+
upstream docs.
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
const controlledValue = signal(50);
|
|
60
|
+
|
|
61
|
+
<ui-label id="progress-controlled-label" class="mb-2 flex items-center gap-3">
|
|
62
|
+
<span>Upload progress</span>
|
|
63
|
+
<span class="ms-auto text-muted-foreground">{{ controlledValue() }}%</span>
|
|
64
|
+
</ui-label>
|
|
65
|
+
|
|
66
|
+
<ui-progress [value]="controlledValue()" aria-labelledby="progress-controlled-label" class="w-full" />
|
|
67
|
+
|
|
68
|
+
<ui-label for="progress-controlled-slider" class="mb-2 block">Adjust progress</ui-label>
|
|
69
|
+
<input
|
|
70
|
+
id="progress-controlled-slider"
|
|
71
|
+
type="range"
|
|
72
|
+
ui-slider
|
|
73
|
+
min="0"
|
|
74
|
+
max="100"
|
|
75
|
+
step="1"
|
|
76
|
+
[value]="controlledValue()"
|
|
77
|
+
(input)="onControlledInput($event)" />
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Indeterminate loading
|
|
81
|
+
|
|
82
|
+
Switch to `indeterminate` when work is running but no stable percentage is
|
|
83
|
+
available yet.
|
|
84
|
+
|
|
85
|
+
```html
|
|
86
|
+
<ui-progress [indeterminate]="true" aria-label="Loading deployment" class="w-full max-w-sm" />
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### RTL
|
|
90
|
+
|
|
91
|
+
Follow the upstream guidance by setting `dir="rtl"` on the surrounding
|
|
92
|
+
container and flipping the bar with `rtl:rotate-180`.
|
|
93
|
+
|
|
94
|
+
```html
|
|
95
|
+
<section dir="rtl" lang="ar" class="w-full max-w-sm text-right">
|
|
96
|
+
<ui-label id="progress-rtl-label" class="mb-2 flex items-center gap-3">
|
|
97
|
+
<span>تقدم الرفع</span>
|
|
98
|
+
<span class="ms-auto text-muted-foreground">٦٦%</span>
|
|
99
|
+
</ui-label>
|
|
100
|
+
|
|
101
|
+
<ui-progress [value]="66" aria-labelledby="progress-rtl-label" class="w-full rtl:rotate-180" />
|
|
102
|
+
</section>
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## API reference
|
|
106
|
+
|
|
107
|
+
| Input | Type | Default |
|
|
108
|
+
| ----------------- | ---------------- | ------- |
|
|
109
|
+
| `value` | `number \| null` | `0` |
|
|
110
|
+
| `max` | `number` | `100` |
|
|
111
|
+
| `indeterminate` | `boolean` | `false` |
|
|
112
|
+
| `aria-label` | `string \| null` | `null` |
|
|
113
|
+
| `aria-labelledby` | `string \| null` | `null` |
|
|
114
|
+
| `class` | `string` | `''` |
|
|
115
|
+
|
|
116
|
+
Native host attributes such as `id`, `dir`, and `data-*` still pass through to
|
|
117
|
+
the rendered custom element and can be used for surrounding composition.
|
|
118
|
+
|
|
119
|
+
## Styling and theming
|
|
120
|
+
|
|
121
|
+
Tokens consumed:
|
|
122
|
+
|
|
123
|
+
- `--secondary` for the track.
|
|
124
|
+
- `--primary` for the indicator.
|
|
125
|
+
|
|
126
|
+
Use the `class` input for width and layout utilities such as `w-full`,
|
|
127
|
+
`max-w-sm`, or `rtl:rotate-180`. Indeterminate state is animated via a CSS
|
|
128
|
+
keyframe that respects `prefers-reduced-motion`.
|
|
129
|
+
|
|
130
|
+
## Accessibility
|
|
131
|
+
|
|
132
|
+
- Host is `role="progressbar"`.
|
|
133
|
+
- Determinate mode sets `aria-valuemin="0"`, `aria-valuemax="max"`, and
|
|
134
|
+
`aria-valuenow="clamped value"`.
|
|
135
|
+
- Indeterminate mode omits `aria-valuenow` and adds `data-state="indeterminate"`.
|
|
136
|
+
- Always provide an accessible name via `aria-label` or `aria-labelledby`.
|
|
137
|
+
- If visible label text already exists on the page, connect it with
|
|
138
|
+
`aria-labelledby` instead of relying on native label semantics.
|
|
139
|
+
|
|
140
|
+
## Keyboard interactions
|
|
141
|
+
|
|
142
|
+
Progress is passive and not focusable by default. Any keyboard interaction
|
|
143
|
+
belongs to surrounding controls such as the slider used in the controlled
|
|
144
|
+
example.
|
|
145
|
+
|
|
146
|
+
## Angular notes
|
|
147
|
+
|
|
148
|
+
- Keep Progress focused on status display. Do not nest buttons or other
|
|
149
|
+
interactive controls inside the bar.
|
|
150
|
+
- Drive determinate state from signals, reactive forms, or any other existing
|
|
151
|
+
Angular state source.
|
|
152
|
+
- For visible label rows, `ui-label` is a good lightweight companion, but plain
|
|
153
|
+
text with the right ARIA wiring works too.
|
|
154
|
+
|
|
155
|
+
## Source parity
|
|
156
|
+
|
|
157
|
+
This Angular implementation follows the shadcn Radix progress examples while
|
|
158
|
+
translating `Field` and `FieldLabel` to ordinary Angular markup plus explicit
|
|
159
|
+
ARIA wiring. The controlled example reuses the existing range slider directive,
|
|
160
|
+
and the RTL pattern matches the upstream `rtl:rotate-180` approach.
|
package/radio/README.md
ADDED
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# Radio Group
|
|
2
|
+
|
|
3
|
+
Accessible exclusive-choice control composed from `ui-radio-group` and `ui-radio`.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import {
|
|
9
|
+
FormContentComponent,
|
|
10
|
+
FormDescriptionComponent,
|
|
11
|
+
FormFieldComponent,
|
|
12
|
+
FormFieldsetComponent,
|
|
13
|
+
FormLegendComponent,
|
|
14
|
+
FormTitleComponent,
|
|
15
|
+
} from '@edsis/ui/form';
|
|
16
|
+
import { LabelComponent } from '@edsis/ui/label';
|
|
17
|
+
import { RadioComponent, RadioGroupComponent } from '@edsis/ui/radio';
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Composition
|
|
21
|
+
|
|
22
|
+
The upstream shadcn `RadioGroup` examples map to the existing Angular radio and form primitives.
|
|
23
|
+
|
|
24
|
+
```text
|
|
25
|
+
ui-radio-group
|
|
26
|
+
├── label[ui-label]
|
|
27
|
+
│ ├── ui-radio
|
|
28
|
+
│ └── ui-form-content
|
|
29
|
+
│ ├── ui-form-title
|
|
30
|
+
│ └── p[ui-form-description]
|
|
31
|
+
└── label[ui-label]
|
|
32
|
+
├── ui-radio
|
|
33
|
+
└── copy or ui-form-content
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Basic Usage
|
|
37
|
+
|
|
38
|
+
Use `ui-radio-group` as the value owner and wrap each option in `label[ui-label]` when the whole row should toggle the radio.
|
|
39
|
+
|
|
40
|
+
```html
|
|
41
|
+
<ui-radio-group name="density" [(ngModel)]="density" class="w-fit">
|
|
42
|
+
<label ui-label class="flex items-center gap-3">
|
|
43
|
+
<ui-radio value="default" />
|
|
44
|
+
<span>Default</span>
|
|
45
|
+
</label>
|
|
46
|
+
<label ui-label class="flex items-center gap-3">
|
|
47
|
+
<ui-radio value="comfortable" />
|
|
48
|
+
<span>Comfortable</span>
|
|
49
|
+
</label>
|
|
50
|
+
<label ui-label class="flex items-center gap-3">
|
|
51
|
+
<ui-radio value="compact" />
|
|
52
|
+
<span>Compact</span>
|
|
53
|
+
</label>
|
|
54
|
+
</ui-radio-group>
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Reactive forms also work because the group implements `ControlValueAccessor`.
|
|
58
|
+
|
|
59
|
+
## Common Patterns
|
|
60
|
+
|
|
61
|
+
### Descriptive rows
|
|
62
|
+
|
|
63
|
+
Map the shadcn `Field` and `FieldContent` helpers to `ui-form-field` and `ui-form-content`.
|
|
64
|
+
|
|
65
|
+
```html
|
|
66
|
+
<ui-radio-group name="density" [(ngModel)]="density" class="w-full max-w-md">
|
|
67
|
+
<label ui-label class="block rounded-xl border border-border bg-card/40 p-4">
|
|
68
|
+
<ui-form-field orientation="horizontal" class="gap-4">
|
|
69
|
+
<ui-radio value="default" />
|
|
70
|
+
<ui-form-content>
|
|
71
|
+
<ui-form-title>Default</ui-form-title>
|
|
72
|
+
<p ui-form-description>Standard spacing for most use cases.</p>
|
|
73
|
+
</ui-form-content>
|
|
74
|
+
</ui-form-field>
|
|
75
|
+
</label>
|
|
76
|
+
</ui-radio-group>
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Choice cards
|
|
80
|
+
|
|
81
|
+
Wrap each plan card in `label[ui-label]` so the full surface toggles the choice.
|
|
82
|
+
|
|
83
|
+
```html
|
|
84
|
+
<ui-radio-group name="plan" [(ngModel)]="selectedPlan" class="w-full max-w-md">
|
|
85
|
+
<label ui-label class="block rounded-xl border border-border bg-card/40 p-4">
|
|
86
|
+
<ui-form-field orientation="horizontal" class="items-start gap-4">
|
|
87
|
+
<ui-form-content>
|
|
88
|
+
<ui-form-title>Pro</ui-form-title>
|
|
89
|
+
<p ui-form-description>For growing businesses.</p>
|
|
90
|
+
</ui-form-content>
|
|
91
|
+
<ui-radio value="pro" />
|
|
92
|
+
</ui-form-field>
|
|
93
|
+
</label>
|
|
94
|
+
</ui-radio-group>
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Semantic fieldsets
|
|
98
|
+
|
|
99
|
+
Use a real fieldset and legend when the radio list answers one grouped question.
|
|
100
|
+
|
|
101
|
+
```html
|
|
102
|
+
<fieldset ui-form-fieldset class="max-w-md rounded-xl border border-border bg-card/40 p-5">
|
|
103
|
+
<legend ui-form-legend variant="label">Subscription plan</legend>
|
|
104
|
+
<p class="text-sm leading-6 text-muted-foreground">Yearly and lifetime plans offer significant savings.</p>
|
|
105
|
+
|
|
106
|
+
<ui-radio-group name="subscription-plan" [(ngModel)]="subscriptionPlan" class="mt-4">
|
|
107
|
+
<label ui-label class="block rounded-lg border border-border/70 bg-background/80 p-3">
|
|
108
|
+
<ui-form-field orientation="horizontal" class="gap-4">
|
|
109
|
+
<ui-radio value="monthly" />
|
|
110
|
+
<ui-form-content>
|
|
111
|
+
<ui-form-title>Monthly ($9.99/month)</ui-form-title>
|
|
112
|
+
</ui-form-content>
|
|
113
|
+
</ui-form-field>
|
|
114
|
+
</label>
|
|
115
|
+
</ui-radio-group>
|
|
116
|
+
</fieldset>
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Validation and helper text
|
|
120
|
+
|
|
121
|
+
Forward helper and error relationships from the group when the descriptive copy sits outside the individual items.
|
|
122
|
+
|
|
123
|
+
```html
|
|
124
|
+
<ui-form-field invalid class="max-w-md rounded-xl border border-destructive/40 bg-destructive/5 p-5">
|
|
125
|
+
<ui-form-title>Notification Preferences</ui-form-title>
|
|
126
|
+
<p id="notification-help" class="text-sm leading-6 text-muted-foreground">
|
|
127
|
+
Choose how you want to receive notifications.
|
|
128
|
+
</p>
|
|
129
|
+
|
|
130
|
+
<ui-radio-group
|
|
131
|
+
name="notification-preferences"
|
|
132
|
+
[(ngModel)]="notificationPreference"
|
|
133
|
+
aria-describedby="notification-help notification-error"
|
|
134
|
+
aria-invalid="true">
|
|
135
|
+
<label ui-label class="block rounded-lg border border-destructive/40 bg-background/80 p-3">
|
|
136
|
+
<ui-form-field orientation="horizontal" class="gap-4">
|
|
137
|
+
<ui-radio value="email" />
|
|
138
|
+
<ui-form-content>
|
|
139
|
+
<ui-form-title>Email only</ui-form-title>
|
|
140
|
+
</ui-form-content>
|
|
141
|
+
</ui-form-field>
|
|
142
|
+
</label>
|
|
143
|
+
</ui-radio-group>
|
|
144
|
+
|
|
145
|
+
<p id="notification-error" class="text-sm font-medium text-destructive">
|
|
146
|
+
Select one delivery channel before saving notification settings.
|
|
147
|
+
</p>
|
|
148
|
+
</ui-form-field>
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
## API Reference
|
|
152
|
+
|
|
153
|
+
### `RadioGroupComponent`
|
|
154
|
+
|
|
155
|
+
| Input | Type | Default | Notes |
|
|
156
|
+
| ------------------ | ---------------------------- | ------------ | ------------------------------------------------------------ |
|
|
157
|
+
| `name` | `string` | `''` | Forwarded to the underlying Material radio group. |
|
|
158
|
+
| `orientation` | `'horizontal' \| 'vertical'` | `'vertical'` | Switches between stacked rows and inline columns. |
|
|
159
|
+
| `aria-label` | `string \| null` | `null` | Use when the group needs an explicit accessible name. |
|
|
160
|
+
| `aria-labelledby` | `string \| null` | `null` | Alternative to `aria-label` for external group headings. |
|
|
161
|
+
| `aria-describedby` | `string \| null` | `null` | Connects helper or error text outside the group. |
|
|
162
|
+
| `aria-invalid` | `boolean \| string \| null` | `null` | Marks the group invalid for validation-driven presentations. |
|
|
163
|
+
| `class` | `string` | `''` | Adds utility classes to the wrapped group host. |
|
|
164
|
+
|
|
165
|
+
| Output | Payload |
|
|
166
|
+
| ------------- | -------- |
|
|
167
|
+
| `valueChange` | `string` |
|
|
168
|
+
|
|
169
|
+
Public method: `focus()`.
|
|
170
|
+
|
|
171
|
+
### `RadioComponent`
|
|
172
|
+
|
|
173
|
+
| Input | Type | Default |
|
|
174
|
+
| ---------- | --------- | ------- |
|
|
175
|
+
| `value` | `string` | — |
|
|
176
|
+
| `disabled` | `boolean` | `false` |
|
|
177
|
+
| `class` | `string` | `''` |
|
|
178
|
+
|
|
179
|
+
## Styling and Theming
|
|
180
|
+
|
|
181
|
+
The radio primitives wrap Angular Material's structural radio markup and restyle it through the shared theme tokens.
|
|
182
|
+
|
|
183
|
+
- The selected dot uses the `primary` token.
|
|
184
|
+
- Unselected outlines use the `input` token rather than current text color.
|
|
185
|
+
- The group uses CSS grid; horizontal orientation flips to `grid-flow-col auto-cols-max`.
|
|
186
|
+
- Card-style layouts and invalid treatments are best handled by surrounding `label[ui-label]` and `ui-form-field` composition.
|
|
187
|
+
|
|
188
|
+
## Accessibility
|
|
189
|
+
|
|
190
|
+
- Use a real `fieldset` and `legend` when the radio list answers one grouped question.
|
|
191
|
+
- Wrap each option in `label[ui-label]` when the whole row or card should toggle the control.
|
|
192
|
+
- Use `aria-describedby` on `ui-radio-group` to connect helper or error text rendered outside the option rows.
|
|
193
|
+
- Use `aria-invalid` on `ui-radio-group` when validation fails and the group should be announced as invalid.
|
|
194
|
+
|
|
195
|
+
## Keyboard Interactions
|
|
196
|
+
|
|
197
|
+
- `Tab` moves focus to the selected item or first enabled item in the group.
|
|
198
|
+
- Arrow keys move between options using Angular Material's radio-group behavior.
|
|
199
|
+
- `Space` selects the focused option.
|
|
200
|
+
|
|
201
|
+
## Angular Notes
|
|
202
|
+
|
|
203
|
+
- `ui-radio-group` owns the selected value and works with both `ngModel` and reactive forms.
|
|
204
|
+
- `ui-radio` represents only the selectable item; visible copy usually lives beside it in a wrapper label or `ui-form-content` block.
|
|
205
|
+
- The shadcn `Field` family maps to the existing `form` entrypoint rather than a separate radio-specific helper package.
|
|
206
|
+
|
|
207
|
+
## Source Parity
|
|
208
|
+
|
|
209
|
+
This Angular implementation follows the same high-value shadcn radio-group examples: descriptive rows, choice cards, semantic fieldsets, disabled states, invalid messaging, and RTL. The deliberate difference is the use of the existing `form` and `label` primitives instead of introducing a separate runtime `Field` API.
|