@htmlbricks/hb-sidenav-link 0.66.8 → 0.66.9
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 +38 -0
- package/manifest.json +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
## `hb-sidenav-link` — sidenav link
|
|
2
|
+
|
|
3
|
+
**Category:** layout
|
|
4
|
+
**Tags:** layout, navigation
|
|
5
|
+
|
|
6
|
+
### What it does
|
|
7
|
+
|
|
8
|
+
Sidebar nav item: Bootstrap icon, label, optional badge, and either a flat link that dispatches `pageChange` on click or an expandable group of `subLinks` with active state when `navpage` or `selected` matches. Intended for use inside `hb-sidebar-desktop` lists.
|
|
9
|
+
|
|
10
|
+
### Custom element
|
|
11
|
+
|
|
12
|
+
`hb-sidenav-link`
|
|
13
|
+
|
|
14
|
+
### Attributes (snake_case; use string values in HTML)
|
|
15
|
+
|
|
16
|
+
- `id`, `style` (optional): strings.
|
|
17
|
+
- `navlink` (required): JSON string — `INavLink` (`label`, `key`, optional `icon`, `group`, `badge`, `subLinks`, `active`, `open`).
|
|
18
|
+
- `navpage` (optional): string — current app page key for active styling.
|
|
19
|
+
- `selected` (optional): boolean string — force selected appearance.
|
|
20
|
+
|
|
21
|
+
### Events
|
|
22
|
+
|
|
23
|
+
- `pageChange`: `{ page: string }`.
|
|
24
|
+
|
|
25
|
+
### Usage notes
|
|
26
|
+
|
|
27
|
+
- **CSS parts:** `li`.
|
|
28
|
+
- **CSS variables:** `--bs-primary`.
|
|
29
|
+
- Export type `INavLink` is shared with `hb-offcanvas` / `hb-sidebar-desktop` `navlinks` arrays.
|
|
30
|
+
|
|
31
|
+
### Minimal HTML example
|
|
32
|
+
|
|
33
|
+
```html
|
|
34
|
+
<hb-sidenav-link
|
|
35
|
+
navpage="home"
|
|
36
|
+
navlink='{"label":"Home","key":"home","icon":"house-door"}'
|
|
37
|
+
></hb-sidenav-link>
|
|
38
|
+
```
|
package/manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@htmlbricks/hb-sidenav-link",
|
|
3
|
-
"version": "0.66.
|
|
3
|
+
"version": "0.66.9",
|
|
4
4
|
"contributors": [],
|
|
5
5
|
"description": "Sidebar nav item: Bootstrap icon, label, optional badge, and either a flat link that dispatches pageChange on click or an expandable group of subLinks with active state when navpage or selected matches. Intended for use inside sidebar-desktop lists.",
|
|
6
6
|
"licenses": [
|