@daffodil/design 0.81.0 → 0.82.0

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 (243) hide show
  1. package/accordion/README.md +44 -29
  2. package/accordion/accordion/accordion/accordion.component.d.ts +3 -0
  3. package/accordion/accordion/accordion-item/accordion-item.component.d.ts +23 -12
  4. package/accordion/accordion/accordion-item-title/accordion-item-title.directive.d.ts +3 -0
  5. package/accordion/accordion.d.ts +5 -0
  6. package/accordion/examples/disabled-accordion/disabled-accordion.component.d.ts +5 -0
  7. package/accordion/examples/initially-expanded-accordion/initially-expanded-accordion.component.d.ts +5 -0
  8. package/accordion/examples/public_api.d.ts +2 -0
  9. package/article/README.md +4 -3
  10. package/article/article.d.ts +3 -0
  11. package/article/src/article-theme.scss +25 -2
  12. package/breadcrumb/README.md +38 -28
  13. package/breadcrumb/breadcrumb/breadcrumb.component.d.ts +15 -2
  14. package/breadcrumb/breadcrumb-item/breadcrumb-item.directive.d.ts +18 -4
  15. package/breadcrumb/breadcrumb.d.ts +3 -0
  16. package/breadcrumb/examples/iterated-breadcrumb/iterated-breadcrumb.component.d.ts +6 -0
  17. package/breadcrumb/public_api.d.ts +2 -2
  18. package/button/README.md +43 -23
  19. package/button/button/basic/button.component.d.ts +5 -1
  20. package/button/button/button-base.directive.d.ts +11 -3
  21. package/button/button/button-sizable.directive.d.ts +1 -1
  22. package/button/button/raised/raised.component.d.ts +2 -0
  23. package/button/button/stroked/stroked.component.d.ts +5 -1
  24. package/button/button.d.ts +4 -2
  25. package/button/button.module.d.ts +1 -2
  26. package/button/examples/elevated-button/elevated-button.component.d.ts +6 -0
  27. package/button/examples/examples.d.ts +2 -1
  28. package/button/examples/public_api.d.ts +1 -0
  29. package/button/public_api.d.ts +0 -1
  30. package/button/src/button/basic/button-theme.scss +180 -80
  31. package/button/src/button/button-base.scss +26 -15
  32. package/button/src/button/flat/flat-theme.scss +144 -85
  33. package/button/src/button/raised/raised-theme.scss +2 -7
  34. package/button/src/button/stroked/stroked-theme.scss +126 -92
  35. package/button/src/button/underline/underline-theme.scss +112 -44
  36. package/callout/README.md +4 -3
  37. package/callout/callout.d.ts +3 -0
  38. package/card/README.md +6 -3
  39. package/card/card/basic/basic.component.d.ts +7 -0
  40. package/card/card/raised/raised.component.d.ts +7 -0
  41. package/card/card/stroked/stroked.component.d.ts +7 -0
  42. package/card/card-base.directive.d.ts +25 -0
  43. package/card/card.d.ts +18 -1
  44. package/card/card.module.d.ts +10 -8
  45. package/card/public_api.d.ts +6 -1
  46. package/card/src/card/raised/raised-theme.scss +30 -0
  47. package/card/src/card/stroked/stroked-theme.scss +46 -0
  48. package/card/src/card-base-theme.scss +126 -0
  49. package/card/src/card-base.scss +134 -0
  50. package/container/README.md +5 -3
  51. package/container/container.d.ts +3 -0
  52. package/core/colorable/colorable.d.ts +20 -14
  53. package/core/colorable/colorable.directive.d.ts +9 -6
  54. package/fesm2022/daffodil-design-accordion-examples.mjs +28 -4
  55. package/fesm2022/daffodil-design-accordion-examples.mjs.map +1 -1
  56. package/fesm2022/daffodil-design-accordion.mjs +56 -29
  57. package/fesm2022/daffodil-design-accordion.mjs.map +1 -1
  58. package/fesm2022/daffodil-design-article-examples.mjs +30 -30
  59. package/fesm2022/daffodil-design-article.mjs +14 -11
  60. package/fesm2022/daffodil-design-article.mjs.map +1 -1
  61. package/fesm2022/daffodil-design-breadcrumb-examples.mjs +24 -4
  62. package/fesm2022/daffodil-design-breadcrumb-examples.mjs.map +1 -1
  63. package/fesm2022/daffodil-design-breadcrumb.mjs +78 -40
  64. package/fesm2022/daffodil-design-breadcrumb.mjs.map +1 -1
  65. package/fesm2022/daffodil-design-button-examples.mjs +55 -33
  66. package/fesm2022/daffodil-design-button-examples.mjs.map +1 -1
  67. package/fesm2022/daffodil-design-button.mjs +79 -69
  68. package/fesm2022/daffodil-design-button.mjs.map +1 -1
  69. package/fesm2022/daffodil-design-callout-examples.mjs +12 -12
  70. package/fesm2022/daffodil-design-callout-examples.mjs.map +1 -1
  71. package/fesm2022/daffodil-design-callout.mjs +25 -22
  72. package/fesm2022/daffodil-design-callout.mjs.map +1 -1
  73. package/fesm2022/daffodil-design-card-examples.mjs +23 -21
  74. package/fesm2022/daffodil-design-card-examples.mjs.map +1 -1
  75. package/fesm2022/daffodil-design-card.mjs +140 -86
  76. package/fesm2022/daffodil-design-card.mjs.map +1 -1
  77. package/fesm2022/daffodil-design-checkbox-examples.mjs +6 -6
  78. package/fesm2022/daffodil-design-checkbox-examples.mjs.map +1 -1
  79. package/fesm2022/daffodil-design-container-examples.mjs +3 -3
  80. package/fesm2022/daffodil-design-container.mjs +10 -7
  81. package/fesm2022/daffodil-design-container.mjs.map +1 -1
  82. package/fesm2022/daffodil-design-hero-examples.mjs +12 -12
  83. package/fesm2022/daffodil-design-hero-examples.mjs.map +1 -1
  84. package/fesm2022/daffodil-design-hero.mjs +25 -22
  85. package/fesm2022/daffodil-design-hero.mjs.map +1 -1
  86. package/fesm2022/daffodil-design-image-examples.mjs +9 -9
  87. package/fesm2022/daffodil-design-image.mjs +36 -19
  88. package/fesm2022/daffodil-design-image.mjs.map +1 -1
  89. package/fesm2022/daffodil-design-input-examples.mjs +12 -12
  90. package/fesm2022/daffodil-design-link-set.mjs +19 -16
  91. package/fesm2022/daffodil-design-link-set.mjs.map +1 -1
  92. package/fesm2022/daffodil-design-list-examples.mjs +12 -12
  93. package/fesm2022/daffodil-design-list.mjs +13 -10
  94. package/fesm2022/daffodil-design-list.mjs.map +1 -1
  95. package/fesm2022/daffodil-design-loading-icon-examples.mjs +4 -4
  96. package/fesm2022/daffodil-design-loading-icon-examples.mjs.map +1 -1
  97. package/fesm2022/daffodil-design-loading-icon.mjs +11 -8
  98. package/fesm2022/daffodil-design-loading-icon.mjs.map +1 -1
  99. package/fesm2022/daffodil-design-media-gallery-examples.mjs +62 -13
  100. package/fesm2022/daffodil-design-media-gallery-examples.mjs.map +1 -1
  101. package/fesm2022/daffodil-design-media-gallery.mjs +165 -250
  102. package/fesm2022/daffodil-design-media-gallery.mjs.map +1 -1
  103. package/fesm2022/daffodil-design-menu-examples.mjs +6 -6
  104. package/fesm2022/daffodil-design-menu-examples.mjs.map +1 -1
  105. package/fesm2022/daffodil-design-menu.mjs +16 -16
  106. package/fesm2022/daffodil-design-modal-examples.mjs +7 -7
  107. package/fesm2022/daffodil-design-modal-examples.mjs.map +1 -1
  108. package/fesm2022/daffodil-design-modal.mjs +28 -25
  109. package/fesm2022/daffodil-design-modal.mjs.map +1 -1
  110. package/fesm2022/daffodil-design-navbar-examples.mjs +12 -12
  111. package/fesm2022/daffodil-design-navbar-examples.mjs.map +1 -1
  112. package/fesm2022/daffodil-design-navbar.mjs +10 -7
  113. package/fesm2022/daffodil-design-navbar.mjs.map +1 -1
  114. package/fesm2022/daffodil-design-notification-examples.mjs +15 -15
  115. package/fesm2022/daffodil-design-notification.mjs +22 -19
  116. package/fesm2022/daffodil-design-notification.mjs.map +1 -1
  117. package/fesm2022/daffodil-design-paginator-examples.mjs +6 -6
  118. package/fesm2022/daffodil-design-paginator.mjs +13 -7
  119. package/fesm2022/daffodil-design-paginator.mjs.map +1 -1
  120. package/fesm2022/daffodil-design-progress-bar-examples.mjs +9 -9
  121. package/fesm2022/daffodil-design-progress-bar.mjs +13 -10
  122. package/fesm2022/daffodil-design-progress-bar.mjs.map +1 -1
  123. package/fesm2022/daffodil-design-quantity-field-examples.mjs +12 -12
  124. package/fesm2022/daffodil-design-radio-examples.mjs +3 -3
  125. package/fesm2022/daffodil-design-sidebar-examples.mjs +14 -14
  126. package/fesm2022/daffodil-design-sidebar-examples.mjs.map +1 -1
  127. package/fesm2022/daffodil-design-sidebar.mjs +147 -53
  128. package/fesm2022/daffodil-design-sidebar.mjs.map +1 -1
  129. package/fesm2022/daffodil-design-switch-examples.mjs +15 -15
  130. package/fesm2022/daffodil-design-switch-examples.mjs.map +1 -1
  131. package/fesm2022/daffodil-design-switch.mjs +6 -3
  132. package/fesm2022/daffodil-design-switch.mjs.map +1 -1
  133. package/fesm2022/daffodil-design-tabs-examples.mjs +23 -17
  134. package/fesm2022/daffodil-design-tabs-examples.mjs.map +1 -1
  135. package/fesm2022/daffodil-design-tabs.mjs +66 -34
  136. package/fesm2022/daffodil-design-tabs.mjs.map +1 -1
  137. package/fesm2022/daffodil-design-text-snippet-examples.mjs +3 -3
  138. package/fesm2022/daffodil-design-text-snippet.mjs +4 -5
  139. package/fesm2022/daffodil-design-text-snippet.mjs.map +1 -1
  140. package/fesm2022/daffodil-design-toast-examples.mjs +40 -15
  141. package/fesm2022/daffodil-design-toast-examples.mjs.map +1 -1
  142. package/fesm2022/daffodil-design-toast.mjs +301 -245
  143. package/fesm2022/daffodil-design-toast.mjs.map +1 -1
  144. package/fesm2022/daffodil-design-tree-examples.mjs +6 -6
  145. package/fesm2022/daffodil-design-tree.mjs +13 -10
  146. package/fesm2022/daffodil-design-tree.mjs.map +1 -1
  147. package/fesm2022/daffodil-design-youtube-player.mjs +104 -0
  148. package/fesm2022/daffodil-design-youtube-player.mjs.map +1 -0
  149. package/fesm2022/daffodil-design.mjs +167 -155
  150. package/fesm2022/daffodil-design.mjs.map +1 -1
  151. package/hero/README.md +4 -3
  152. package/hero/hero.d.ts +3 -0
  153. package/image/README.md +4 -3
  154. package/image/image/image.component.d.ts +22 -1
  155. package/image/image.d.ts +3 -0
  156. package/link-set/README.md +4 -3
  157. package/link-set/link-set.d.ts +3 -0
  158. package/list/README.md +4 -3
  159. package/list/list.d.ts +3 -0
  160. package/loading-icon/README.md +10 -7
  161. package/loading-icon/loading-icon.d.ts +3 -0
  162. package/loading-icon/src/loading-icon-theme.scss +66 -38
  163. package/media-gallery/README.md +17 -8
  164. package/media-gallery/examples/iterated-media-gallery/iterated-media-gallery.component.d.ts +13 -0
  165. package/media-gallery/examples/media-gallery-with-video/media-gallery-with-video.component.d.ts +5 -0
  166. package/media-gallery/examples/public_api.d.ts +2 -0
  167. package/media-gallery/helpers/media-gallery-registration.interface.d.ts +1 -1
  168. package/media-gallery/media-gallery/media-gallery.component.d.ts +73 -11
  169. package/media-gallery/media-gallery.d.ts +4 -2
  170. package/media-gallery/media-gallery.module.d.ts +1 -2
  171. package/media-gallery/public_api.d.ts +0 -1
  172. package/media-gallery/src/media-gallery-theme.scss +30 -4
  173. package/media-gallery/thumbnail/thumbnail.directive.d.ts +29 -23
  174. package/menu/README.md +1 -2
  175. package/modal/README.md +3 -2
  176. package/modal/modal.d.ts +3 -0
  177. package/navbar/README.md +3 -2
  178. package/navbar/navbar.d.ts +3 -0
  179. package/notification/README.md +5 -4
  180. package/notification/notification.d.ts +3 -0
  181. package/package.json +1 -1
  182. package/paginator/README.md +3 -2
  183. package/paginator/paginator/paginator.component.d.ts +3 -0
  184. package/paginator/paginator.d.ts +3 -0
  185. package/progress-bar/README.md +3 -2
  186. package/progress-bar/progress-bar.d.ts +3 -0
  187. package/scss/theme.scss +36 -17
  188. package/scss/theming/_configure-theme.scss +2 -0
  189. package/scss/theming/_index.scss +1 -0
  190. package/scss/theming/_light-dark.scss +45 -0
  191. package/sidebar/README.md +20 -21
  192. package/sidebar/helper/sidebar-mode.d.ts +9 -15
  193. package/sidebar/sidebar/sidebar.component.d.ts +22 -7
  194. package/sidebar/sidebar-footer/sidebar-footer.component.d.ts +11 -0
  195. package/sidebar/sidebar-header/sidebar-header-title/sidebar-header-title.directive.d.ts +8 -0
  196. package/sidebar/sidebar-header/sidebar-header.component.d.ts +19 -1
  197. package/sidebar/sidebar-viewport/sidebar-viewport.component.d.ts +36 -15
  198. package/sidebar/sidebar-viewport-backdrop/sidebar-viewport-backdrop.component.d.ts +17 -0
  199. package/sidebar/sidebar.d.ts +3 -0
  200. package/switch/README.md +3 -2
  201. package/switch/switch.d.ts +3 -0
  202. package/tabs/README.md +33 -3
  203. package/tabs/tabs/tab/tab.component.d.ts +1 -1
  204. package/tabs/tabs/tab-label/tab-label.component.d.ts +6 -0
  205. package/tabs/tabs/tab-panel/tab-panel.component.d.ts +8 -0
  206. package/tabs/tabs/tabs.component.d.ts +21 -4
  207. package/tabs/tabs.d.ts +8 -2
  208. package/text-snippet/README.md +19 -1
  209. package/toast/README.md +21 -151
  210. package/toast/examples/dismissible-toast/dismissible-toast.component.d.ts +11 -0
  211. package/toast/examples/public_api.d.ts +2 -1
  212. package/toast/interfaces/toast-action.d.ts +22 -11
  213. package/toast/interfaces/toast-action.type.d.ts +10 -0
  214. package/toast/interfaces/toast.d.ts +11 -5
  215. package/toast/options/daff-toast-options.d.ts +2 -1
  216. package/toast/public_api.d.ts +2 -6
  217. package/toast/service/position.service.d.ts +9 -1
  218. package/toast/service/toast.service.d.ts +63 -0
  219. package/toast/toast/toast-config.d.ts +24 -1
  220. package/toast/toast/toast-provider.d.ts +16 -0
  221. package/toast/toast/toast-template.component.d.ts +1 -3
  222. package/toast/toast/toast.component.d.ts +20 -1
  223. package/toast/toast-actions/toast-actions.directive.d.ts +3 -0
  224. package/toast/toast-message/toast-message.directive.d.ts +3 -0
  225. package/toast/toast-title/toast-title.directive.d.ts +3 -0
  226. package/tree/README.md +6 -10
  227. package/tree/tree.d.ts +3 -0
  228. package/youtube-player/index.d.ts +1 -0
  229. package/youtube-player/public_api.d.ts +3 -0
  230. package/youtube-player/safe-url.pipe.d.ts +10 -0
  231. package/youtube-player/youtube-player.component.d.ts +23 -0
  232. package/youtube-player/youtube-player.d.ts +6 -0
  233. package/card/card/card.component.d.ts +0 -48
  234. package/card/src/card-theme-variants/basic-card.scss +0 -6
  235. package/card/src/card-theme-variants/linkable-card.scss +0 -16
  236. package/card/src/card-theme-variants/stroked-card.scss +0 -3
  237. package/card/src/card-theme.scss +0 -170
  238. package/media-gallery/media-renderer/media-renderer.component.d.ts +0 -29
  239. package/media-gallery/registry/media-gallery.registry.d.ts +0 -34
  240. package/media-gallery/thumbnail/thumbnail-compat.token.d.ts +0 -1
  241. package/media-gallery/thumbnail/thumbnail-registration.interface.d.ts +0 -9
  242. package/scss/theming/prebuilt/internal-theme.scss +0 -13
  243. package/toast/toast.module.d.ts +0 -19
package/sidebar/README.md CHANGED
@@ -10,10 +10,11 @@ Sidebars are often used for navigation, but it's built to be flexible and extens
10
10
  To use sidebar in a standalone component, import `DAFF_SIDEBAR_COMPONENTS` directly into your custom component:
11
11
 
12
12
  ```ts
13
+ import { DAFF_SIDEBAR_COMPONENTS } from '@daffodil/design/sidebar';
14
+
13
15
  @Component({
14
16
  selector: 'custom-component',
15
17
  templateUrl: './custom-component.component.html',
16
- standalone: true,
17
18
  imports: [
18
19
  DAFF_SIDEBAR_COMPONENTS,
19
20
  ],
@@ -26,8 +27,8 @@ To use sidebar in a module, import `DaffSidebarModule` into your custom module:
26
27
 
27
28
  ```ts
28
29
  import { NgModule } from '@angular/core';
29
-
30
30
  import { DaffSidebarModule } from '@daffodil/design/sidebar';
31
+ import { CustomComponent } from './custom.component';
31
32
 
32
33
  @NgModule({
33
34
  declarations: [
@@ -45,6 +46,9 @@ export class CustomComponentModule { }
45
46
 
46
47
  > This method is deprecated. It's recommended to update all custom components to standalone.
47
48
 
49
+ ### Required imports
50
+ The `BrowserAnimationsModule` or `NoopAnimationsModule` must be imported in the particular Angular `@NgModule` the sidebar is used in for the sidebar to render and work properly.
51
+
48
52
  ## Basic sidebar
49
53
  The default setting for sidebar is `mode="side"` and `side="left"`.
50
54
 
@@ -53,6 +57,8 @@ The default setting for sidebar is `mode="side"` and `side="left"`.
53
57
  ## Implementing the main and sidebar content
54
58
  The main and sidebar content should be placed inside of the `<daff-sidebar-viewport>`. The sidebar content should be placed inside of the `<daff-sidebar>`.
55
59
 
60
+ > The sidebar viewport should only ever be used once in an application, but it's possible for there to be multiple sidebars of many modes at the same time.
61
+
56
62
  A viewport navigation can either be:
57
63
 
58
64
  - Placed alongside the `<daff-sidebar>` using the `[daff-sidebar-viewport-nav]` selector.
@@ -91,9 +97,6 @@ A viewport navigation can either be:
91
97
  </daff-sidebar-viewport>
92
98
  ```
93
99
 
94
- ### Required Imports
95
- The `BrowserAnimationsModule` or `NoopAnimationsModule` must be imported in the particular Angular `@NgModule` the sidebar is used in for the sidebar to render and work properly.
96
-
97
100
  ## Header and footer
98
101
  The `<daff-sidebar-header>` includes optional title (`[daffSidebarHeaderTitle]`) and action (`[daffSidebarHeaderAction]`) selectors, and a slot to render custom content. The action selector should be used along with the `<daff-icon-button>` (view [Button Documentation](/libs/design/button/README.md)) to make sure that the action is positioned correctly and it passes WCAG guidelines.
99
102
 
@@ -101,24 +104,20 @@ The `<daff-sidebar-footer>` is a "holder" component with minimal default styling
101
104
 
102
105
  Both the header and footer are optional components that will not render in the DOM if they are not used.
103
106
 
104
- ## Opening and closing a sidebar
105
- THe `open` property is used to set the open state for a sidebar.
106
-
107
- By default, sidebar supports two methods of closing itself: clicking on the backdrop of the sidebar viewport or pressing `ESC` when the sidebar has focus.
107
+ ## Closing a sidebar
108
+ A sidebar can be closed by clicking on the backdrop, using the escape key, or clicking on the close button in the sidebar header.
108
109
 
109
- | Method | ------------------------------------ |
110
- | `(backdropClicked)` | Set on the `<daff-sidebar-viewport>` |
111
- | `(escapePressed)` | Set on the `<daff-sidebar>` |
110
+ > Note: The close button is hidden by default. To make it visible, set the `dismissible` property on the sidebar header to `true`.
112
111
 
113
112
  ## Modes
114
- `<daff-sidebar>` can be rendered four different ways by using the `mode` property. If `mode` is not specified, `side` is used by default.
113
+ A sidebar can be rendered four different ways by using the `mode` property. If `mode` is not specified, `side` is used by default.
115
114
 
116
115
  | Mode | Description |
117
116
  | ---------- | ---------------------------------------------------------------------------------------------------- |
118
- | side | Sidebar is placed alongside the content |
119
- | side-fixed | Sidebar is placed alongside the content and will scroll separately from the content |
120
- | over | Sidebar slides over the rest of the content in the viewport and covering it with a backdrop |
121
- | under | Sidebar freezes in place and and the content slides above it, while also being covered by a backdrop |
117
+ | side | Displays the sidebar alongside the main content. |
118
+ | side-fixed | Displays the sidebar alongside the content, but the sidebar remains fixed in place and scrolls independently from the content. |
119
+ | over | The sidebar slides over the main content when open, temporarily covering part of the content when active. |
120
+ | under | The sidebar remains fixed in place while the main content slides over it when the sidebar is closed. |
122
121
 
123
122
  ### Over sidebar
124
123
  <design-land-example-viewer-container example="over-sidebar"></design-land-example-viewer-container>
@@ -133,7 +132,7 @@ By default, sidebar supports two methods of closing itself: clicking on the back
133
132
  <design-land-example-viewer-container example="fixed-and-over-sidebar"></design-land-example-viewer-container>
134
133
 
135
134
  ## Sides
136
- `<daff-sidebar>` can be positioned on either side of a screen by using the `side` property. If `side` is not specificed, `left` is used by default.
135
+ A sidebar can be positioned on either side of a screen by using the `side` property. If `side` is not specificed, `left` is used by default.
137
136
 
138
137
  | Side | Description |
139
138
  | ----- | ---------------------------------------------- |
@@ -168,7 +167,7 @@ daff-sidebar-viewport {
168
167
  }
169
168
  ```
170
169
 
171
- ## Changing a side-fixed sidebar's top offset position
170
+ ## Changing a side- fixed sidebar's top offset position
172
171
  The default offset position of a sidebar is `0px`. The `--daff-sidebar-side-fixed-top-shift` variable can be used to adjust the top offset position for a primary sidebar and its viewport content.
173
172
 
174
173
  ```scss
@@ -187,7 +186,7 @@ body {
187
186
  ## Accessibility
188
187
  A meaningful `role` should be set on all sidebars depending on how they are used.
189
188
 
190
- When the `<daff-sidebar-header>` is not used or there is no title for the sidebar, a meaningful `aria-label` should be set to describe the sidebar.
189
+ When a sidebar header is not used or there is no title for the sidebar, a meaningful `aria-label` should be set to describe the sidebar.
191
190
 
192
191
  ### Focus
193
- Focus trapping is enabled for `over` and `under` modes, and disabled for `side` and `side-fixed` modes. When a sidebar is opened, the first tabbable element within the will receive focus. When a sidebar is opened, the first tabbable element within the will receive focus. When a sidebar is closed, the element that was focused before the sidebar was opened will be re-focused.
192
+ Focus trapping is enabled for `over` and `under` modes, and disabled for `side` and `side-fixed` modes. When a sidebar is opened, the first tabbable element within the sidebar will receive focus. When a sidebar is closed, the element that was focused before the sidebar was opened will be re-focused.
@@ -1,23 +1,17 @@
1
1
  /**
2
- * The various modes that a DaffSidebar can be in.
2
+ * The available display modes for the `DaffSidebarComponent`.
3
3
  *
4
- * * `side` is a mode that allows you to place the sidebar alongside
5
- * the content.
6
- *
7
- * * `side-fixed` is a mode that allows you want to place the sidebar
8
- * alongside the content, however the sidebar will scroll separately
9
- * from the content.
10
- *
11
- * * `over` is a mode which allows the sidebar to slide *over* the rest of
12
- * the content in the viewport.
13
- *
14
- * * `under` is a mode that freezes the sidebar in place and allows the content
15
- * slide above it.
4
+ * | Mode | Description |
5
+ * | -- | -- |
6
+ * | `side` | Displays the sidebar alongside the main content. |
7
+ * | `side-fixed` | Displays the sidebar alongside the content, but the sidebar remains fixed in place and scrolls independently from the content. |
8
+ * | `over` | The sidebar slides over the main content when open, temporarily covering part of the content when active. |
9
+ * | `under` | The sidebar remains fixed in place while the main content slides over it when the sidebar is closed. |
16
10
  */
17
11
  export type DaffSidebarMode = 'side' | 'over' | 'under' | 'side-fixed';
18
12
  /**
19
- * A enum representing the different sidebar modes.
20
- * See {@link DaffSidebarMode}
13
+ * Enum for representing the available sidebar display modes.
14
+ * See {@link DaffSidebarMode} for descriptions of each mode.
21
15
  */
22
16
  export declare const enum DaffSidebarModeEnum {
23
17
  Side = "side",
@@ -8,9 +8,13 @@ import { DaffSidebarSide } from '../helper/sidebar-side';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "@daffodil/design";
10
10
  /**
11
- * DaffSidebarComponent is heavily based upon the work done by the @angular/components
12
- * team on `mat-drawer` and `mat-sidenav`. `daff-sidebar` is intended to be
13
- * a simplified version (with a different design) of `mat-drawer`.
11
+ * DaffSidebarComponent is heavily based upon the work done by the `@angular/components`
12
+ * team on `mat-drawer` and `mat-sidenav`. It's intended to be a simplified version
13
+ * (with a different design) of `mat-drawer`.
14
+ *
15
+ * ```html
16
+ * <daff-sidebar></daff-sidebar>
17
+ * ```
14
18
  */
15
19
  export declare class DaffSidebarComponent implements DaffOpenable {
16
20
  private _elementRef;
@@ -29,6 +33,8 @@ export declare class DaffSidebarComponent implements DaffOpenable {
29
33
  'daff-sidebar': boolean;
30
34
  };
31
35
  /**
36
+ * @docs-private
37
+ *
32
38
  * The animation state of the sidebar.
33
39
  */
34
40
  get transformSidebar(): {
@@ -38,7 +44,7 @@ export declare class DaffSidebarComponent implements DaffOpenable {
38
44
  };
39
45
  };
40
46
  /**
41
- * Event fired when `ESC` key is pressed when the sidebar has focus
47
+ * Event fired when `ESC` key is pressed when the sidebar has focus.
42
48
  */
43
49
  escapePressed: EventEmitter<void>;
44
50
  /**
@@ -50,33 +56,42 @@ export declare class DaffSidebarComponent implements DaffOpenable {
50
56
  */
51
57
  mode: DaffSidebarMode;
52
58
  /**
59
+ * @docs-private
60
+ *
53
61
  * The width of the sidebar.
54
62
  */
55
63
  get width(): number;
64
+ /**
65
+ * @docs-private
66
+ */
56
67
  get open(): boolean;
57
68
  constructor(_elementRef: ElementRef<HTMLElement>, _ngZone: NgZone, _focusTrapFactory: ConfigurableFocusTrapFactory, _focusStack: DaffFocusStackService, openDirective: DaffOpenableDirective, _doc: any);
58
69
  private _focusTrap;
59
70
  /**
71
+ * @docs-private
72
+ *
60
73
  * Animation event that can be used to hook into when the transformSidebar
61
74
  * animation begins. This is used in sidebar to determine when to show the
62
75
  * visibility of the sidebar so that the animation does not jump as the element is shown.
63
76
  */
64
77
  onAnimationStart(e: AnimationEvent): void;
65
78
  /**
79
+ * @docs-private
80
+ *
66
81
  * Animation event that can be used to hook into when the
67
82
  * transformSidebar animation is complete.
68
83
  */
69
84
  onAnimationComplete(e: AnimationEvent): void;
70
85
  /**
71
- * Reveal the contents of the sidebar
86
+ * Reveal the contents of the sidebar.
72
87
  */
73
88
  reveal(): void;
74
89
  /**
75
- * Hide the contents of the sidebar
90
+ * Hide the contents of the sidebar.
76
91
  */
77
92
  hide(): void;
78
93
  /**
79
- * Toggle the visibility of the sidebar
94
+ * Toggle the visibility of the sidebar.
80
95
  */
81
96
  toggle(): void;
82
97
  static ɵfac: i0.ɵɵFactoryDeclaration<DaffSidebarComponent, never>;
@@ -1,5 +1,16 @@
1
1
  import * as i0 from "@angular/core";
2
+ /**
3
+ * Sidebar footer is a child component of the sidebar that is used to display a
4
+ * footer container, positioned at the bottom of a sidebar.
5
+ *
6
+ * ```html
7
+ * <daff-sidebar-footer></daff-sidebar-footer>
8
+ * ```
9
+ */
2
10
  export declare class DaffSidebarFooterComponent {
11
+ /**
12
+ * @docs-private
13
+ */
3
14
  class: boolean;
4
15
  static ɵfac: i0.ɵɵFactoryDeclaration<DaffSidebarFooterComponent, never>;
5
16
  static ɵcmp: i0.ɵɵComponentDeclaration<DaffSidebarFooterComponent, "daff-sidebar-footer", never, {}, {}, never, ["*"], true, never>;
@@ -1,4 +1,12 @@
1
1
  import * as i0 from "@angular/core";
2
+ /**
3
+ * Sidebar header title is a child directive of `DaffSidebarHeaderComponent`
4
+ * that can be used to provide a title for the sidebar.
5
+ *
6
+ * ```html
7
+ * <div daffSidebarHeaderTitle>Title</div>
8
+ * ```
9
+ */
2
10
  export declare class DaffSidebarHeaderTitleDirective {
3
11
  /**
4
12
  * @docs-private
@@ -1,14 +1,32 @@
1
1
  import { EventEmitter } from '@angular/core';
2
2
  import * as i0 from "@angular/core";
3
+ /**
4
+ * Sidebar header is a child component of the sidebar that is used to display a header container,
5
+ * positioned at the top of a sidebar. It includes an optional title (`[daffSidebarHeaderTitle]`)
6
+ * slot and a slot to render any custom content.
7
+ *
8
+ * ```html
9
+ * <daff-sidebar-header></daff-sidebar-header>
10
+ * ```
11
+ */
3
12
  export declare class DaffSidebarHeaderComponent {
13
+ /**
14
+ * @docs-private
15
+ */
4
16
  faTimes: import("@fortawesome/fontawesome-common-types").IconDefinition;
17
+ /**
18
+ * @docs-private
19
+ */
5
20
  class: boolean;
6
- /** Whether or not a sidebar header displays the close icon */
21
+ /** Whether or not a sidebar header should display the close icon. */
7
22
  dismissible: boolean;
8
23
  /**
9
24
  * Output event triggered when the close icon is clicked.
10
25
  */
11
26
  closeSidebar: EventEmitter<void>;
27
+ /**
28
+ * @docs-private
29
+ */
12
30
  onCloseSidebar(event: Event): void;
13
31
  static ɵfac: i0.ɵɵFactoryDeclaration<DaffSidebarHeaderComponent, never>;
14
32
  static ɵcmp: i0.ɵɵComponentDeclaration<DaffSidebarHeaderComponent, "daff-sidebar-header", never, { "dismissible": { "alias": "dismissible"; "required": false; }; }, { "closeSidebar": "closeSidebar"; }, never, ["*"], true, never>;
@@ -5,23 +5,19 @@ import { DaffSidebarScroll } from './scroll-token/scroll.token';
5
5
  import { DaffSidebarViewportAnimationStateWithParams } from '../animation/sidebar-viewport-animation-state';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * The DaffSidebarViewportComponent is the "holder" of sidebars throughout an entire application.
8
+ * DaffSidebarViewportComponent serves as the container for managing sidebars across an entire application.
9
+ * Because it's a functional component, it supports multiple simultaneously open sidebar and is designed to
10
+ * handle these scenarios gracefully.
9
11
  *
10
- * `<daff-sidebar-viewport>` should only ever be used once in an application,
11
- * but it's possible for there to be multiple sidebars of many modes
12
- * at the same time. See {@link DaffSidebarMode}.
12
+ * > However, there is one key contraint: only one sidebar per **mode** is allowed
13
+ * on each **side** (e.g., left or right) at any given time.
13
14
  *
14
- * Since this is a functional component, it's possible to have multiple "open" sidebars
15
- * at the same time. As a result, this component attempts to gracefully handle these situations.
16
- * However, importantly, there can only be one sidebar of each mode, on each side, at any given time.
15
+ * If this constraint is violated, the component will throw an exception to prevent unintended behavior.
17
16
  *
18
- * If this is violated, this component will throw an exception.
19
- *
20
- * @example Using the sidebar viewport
21
17
  * ```html
22
18
  * <daff-sidebar-viewport>
23
19
  * <daff-sidebar></daff-sidebar>
24
- * <p>Site content</p>
20
+ * <div>Site content</div>
25
21
  * </daff-sidebar-viewport>
26
22
  * ```
27
23
  */
@@ -31,19 +27,33 @@ export declare class DaffSidebarViewportComponent implements AfterContentChecked
31
27
  private bodyScroll;
32
28
  private parentViewport;
33
29
  private scroll;
30
+ /**
31
+ * @docs-private
32
+ */
34
33
  hostClass: boolean;
34
+ /**
35
+ * @docs-private
36
+ */
35
37
  get classes(): {
36
38
  [x: string]: boolean;
37
39
  'daff-sidebar-viewport': boolean;
38
40
  'pad-left': boolean;
39
41
  'pad-right': boolean;
40
42
  };
43
+ /**
44
+ * @docs-private
45
+ */
41
46
  get isNavOnSide(): boolean;
47
+ /**
48
+ * @docs-private
49
+ */
42
50
  onContentAnimationStart(e: AnimationEvent): void;
51
+ /**
52
+ * @docs-private
53
+ */
43
54
  onContentAnimationDone(e: AnimationEvent): void;
44
55
  /**
45
- * The placement of the nav in relation to the sidebar. The default is set to `top`.
46
- * Note that this is really only available when there is a `side-fixed` sidebar.
56
+ * The placement of the nav in relation to the sidebar. Note that this is really only available when there is a `side-fixed` sidebar.
47
57
  */
48
58
  navPlacement: DaffNavPlacement;
49
59
  constructor(cdRef: ChangeDetectorRef, _elementRef: ElementRef<HTMLElement>, bodyScroll: DaffSidebarScroll, parentViewport: any, scroll: DaffSidebarScroll);
@@ -61,10 +71,14 @@ export declare class DaffSidebarViewportComponent implements AfterContentChecked
61
71
  private _isPaddedLeft;
62
72
  private _isPaddedRight;
63
73
  /**
74
+ * @docs-private
75
+ *
64
76
  * Whether or not the backdrop is interactable
65
77
  */
66
78
  _backdropInteractable: boolean;
67
79
  /**
80
+ * @docs-private
81
+ *
68
82
  * The animation state
69
83
  */
70
84
  _animationState: DaffSidebarViewportAnimationStateWithParams;
@@ -72,7 +86,13 @@ export declare class DaffSidebarViewportComponent implements AfterContentChecked
72
86
  * Event fired when the backdrop is clicked. This is often used to close the sidebar.
73
87
  */
74
88
  backdropClicked: EventEmitter<void>;
89
+ /**
90
+ * @docs-private
91
+ */
75
92
  ngAfterContentChecked(): void;
93
+ /**
94
+ * @docs-private
95
+ */
76
96
  ngOnDestroy(): void;
77
97
  /**
78
98
  * @docs-private
@@ -83,9 +103,10 @@ export declare class DaffSidebarViewportComponent implements AfterContentChecked
83
103
  private updateAnimationState;
84
104
  /**
85
105
  * @docs-private
86
- * The called when the backdrop of the viewport is clicked upon.
106
+ *
107
+ * Called when the backdrop of the viewport is clicked upon.
87
108
  */
88
109
  _backdropClicked(): void;
89
110
  static ɵfac: i0.ɵɵFactoryDeclaration<DaffSidebarViewportComponent, [null, null, { skipSelf: true; }, { optional: true; skipSelf: true; }, null]>;
90
- static ɵcmp: i0.ɵɵComponentDeclaration<DaffSidebarViewportComponent, "daff-sidebar-viewport", never, { "navPlacement": { "alias": "navPlacement"; "required": false; }; }, { "backdropClicked": "backdropClicked"; }, ["sidebars"], ["[daff-sidebar-viewport-nav]", "daff-sidebar:not([side=right])", "*", "daff-sidebar[side=right]"], true, never>;
111
+ static ɵcmp: i0.ɵɵComponentDeclaration<DaffSidebarViewportComponent, "daff-sidebar-viewport", never, { "navPlacement": { "alias": "navPlacement"; "required": false; }; }, { "backdropClicked": "backdropClicked"; }, ["sidebars"], ["[daff-sidebar-viewport-nav]", "daff-sidebar:not([side=right])", "*", "[daff-sidebar-viewport-footer]", "daff-sidebar[side=right]"], true, never>;
91
112
  }
@@ -2,6 +2,9 @@ import { AnimationEvent } from '@angular/animations';
2
2
  import { EventEmitter, OnInit } from '@angular/core';
3
3
  import * as i0 from "@angular/core";
4
4
  export declare class DaffSidebarViewportBackdropComponent implements OnInit {
5
+ /**
6
+ * @docs-private
7
+ */
5
8
  interactableClass: boolean;
6
9
  /**
7
10
  * Determines whether or not the backdrop is transparent.
@@ -20,14 +23,28 @@ export declare class DaffSidebarViewportBackdropComponent implements OnInit {
20
23
  * Output event triggered when the backdrop is clicked.
21
24
  */
22
25
  backdropClicked: EventEmitter<void>;
26
+ /**
27
+ * @docs-private
28
+ */
23
29
  ngOnInit(): void;
24
30
  /**
31
+ * @docs-private
32
+ *
25
33
  * Animation hook for that controls the backdrops
26
34
  * entrance and fade animations.
27
35
  */
28
36
  get fadeBackdropTrigger(): import("./animation/backdrop-animation-state").DaffSidebarViewportBackdropAnimationState;
37
+ /**
38
+ * @docs-private
39
+ */
29
40
  animationDone(e: AnimationEvent): void;
41
+ /**
42
+ * @docs-private
43
+ */
30
44
  animationStart(e: AnimationEvent): void;
45
+ /**
46
+ * @docs-private
47
+ */
31
48
  onBackdropClicked(): void;
32
49
  static ɵfac: i0.ɵɵFactoryDeclaration<DaffSidebarViewportBackdropComponent, never>;
33
50
  static ɵcmp: i0.ɵɵComponentDeclaration<DaffSidebarViewportBackdropComponent, "daff-sidebar-viewport-backdrop", never, { "transparent": { "alias": "transparent"; "required": false; }; "interactable": { "alias": "interactable"; "required": false; }; "fullscreen": { "alias": "fullscreen"; "required": false; }; }, { "backdropClicked": "backdropClicked"; }, never, ["*"], true, never>;
@@ -5,4 +5,7 @@ import { DaffSidebarHeaderTitleDirective } from './sidebar-header/sidebar-header
5
5
  import { DaffSidebarHeaderComponent } from './sidebar-header/sidebar-header.component';
6
6
  import { DaffSidebarViewportComponent } from './sidebar-viewport/sidebar-viewport.component';
7
7
  import { DaffSidebarViewportBackdropComponent } from './sidebar-viewport-backdrop/sidebar-viewport-backdrop.component';
8
+ /**
9
+ * @docs-private
10
+ */
8
11
  export declare const DAFF_SIDEBAR_COMPONENTS: readonly [typeof DaffSidebarComponent, typeof DaffSidebarViewportComponent, typeof DaffSidebarHeaderComponent, typeof DaffSidebarFooterComponent, typeof DaffSidebarHeaderTitleDirective, typeof DaffSidebarHeaderActionDirective, typeof DaffSidebarViewportBackdropComponent];
package/switch/README.md CHANGED
@@ -7,13 +7,14 @@ Switches provide a way to toggle between two states with a visual indicator of t
7
7
  ## Usage
8
8
 
9
9
  ### Within a standalone component
10
- To use a switch in a standalone component, import it directly into your custom component:
10
+ To use a switch in a standalone component, import `DAFF_SWITCH_COMPONENTS` directly into your custom component:
11
11
 
12
12
  ```ts
13
+ import { DAFF_SWITCH_COMPONENTS } from '@daffodil/design/switch';
14
+
13
15
  @Component({
14
16
  selector: 'custom-component',
15
17
  templateUrl: './custom-component.component.html',
16
- standalone: true,
17
18
  imports: [
18
19
  DAFF_SWITCH_COMPONENTS,
19
20
  ],
@@ -1,3 +1,6 @@
1
1
  import { DaffErrorMessageModule } from '@daffodil/design';
2
2
  import { DaffSwitchComponent } from './switch/switch.component';
3
+ /**
4
+ * @docs-private
5
+ */
3
6
  export declare const DAFF_SWITCH_COMPONENTS: readonly [typeof DaffSwitchComponent, typeof DaffErrorMessageModule];
package/tabs/README.md CHANGED
@@ -4,12 +4,45 @@ Tabs provide a way to navigate between panels that display related content.
4
4
  ## Overview
5
5
  Tabs allow for users to navigate between related content without having to leave the page. They can be used within components like modals or cards.
6
6
 
7
+ ## Usage
8
+
9
+ ### Within a standalone component
10
+ To use a tabs in a standalone component, import `DAFF_TABS_COMPONENTS` directly into your custom component:
11
+
12
+ ```ts
13
+ import { DAFF_TABS_COMPONENTS } from '@daffodil/design/tabs';
14
+
15
+ @Component({
16
+ selector: 'custom-component',
17
+ templateUrl: './custom-component.component.html',
18
+ imports: [
19
+ DAFF_TABS_COMPONENTS,
20
+ ],
21
+ })
22
+ export class CustomComponent {}
23
+ ```
24
+
25
+ ## Properties
26
+
27
+ ### Link Mode
28
+ Tabs in link mode replaces the tab buttons with anchors. This allows the selected tab to be connected to a URL. By default, the current URL and `tab` query param will be used. These can be overriden with the `url` and `queryParam` inputs respectively.
29
+
30
+ ```html
31
+ <daff-tabs [linkMode]="true">
32
+ </daff-tabs>
33
+ ```
34
+
7
35
  ## Accessbility
8
36
  Tabs follow the [ARIA Tabs design pattern](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/). Tabs compose of `tablist`, `tab`, and `tabpanel` elements, each with its appropriate role and integrated keyboard interactions.
9
37
 
10
38
  ### Label
11
39
  A meaningful `aria-label` should be set on `<daff-tabs>` by using the `aria-label` property. This will set the `aria-label` on the `tablist` element.
12
40
 
41
+ ```html
42
+ <daff-tabs aria-label="Custom aria label">
43
+ </daff-tabs>
44
+ ```
45
+
13
46
  ### Keyboard Interactions
14
47
  | Key | Action |
15
48
  | --- | ------ |
@@ -17,6 +50,3 @@ A meaningful `aria-label` should be set on `<daff-tabs>` by using the `aria-labe
17
50
  | Right Arrow | Moves focus and activates next tab. If focus is on the last tab, moves focus to the first tab. |
18
51
  | Home | Moves focus and activates first tab. |
19
52
  | End | Moves focus and activates last tab. |
20
-
21
- ### Link Mode
22
- Tabs can operate in "link mode" which replaces the tab buttons with anchors. This allows the selected tab to be connected to the URL. To use this mode, set `linkMode` to `true` on the tabs component. By default, the current URL and `tab` query param will be used. These can be overriden with the `url` and `queryParam` inputs respectively.
@@ -3,7 +3,7 @@ import * as i0 from "@angular/core";
3
3
  /**
4
4
  * `DaffTabComponet` is an element in the tab list that is used as a content container to group the label of a tab panel and the tab panel together.
5
5
  *
6
- * A `<daff-tab>` should include the {@link DaffTabLabelComponent} and {@link DaffTabPanelComponent} components in order to properly structure the UI.
6
+ * A `<daff-tab>` should include the DaffTabLabelComponent and DaffTabPanelComponent components in order to properly structure the UI.
7
7
  *
8
8
  * @example Basic structure of tab
9
9
  * ```html
@@ -13,7 +13,13 @@ import * as i0 from "@angular/core";
13
13
  * ```
14
14
  */
15
15
  export declare class DaffTabLabelComponent implements DaffPrefixable, DaffSuffixable {
16
+ /**
17
+ * @docs-private
18
+ */
16
19
  _prefix: DaffPrefixDirective;
20
+ /**
21
+ * @docs-private
22
+ */
17
23
  _suffix: DaffSuffixDirective;
18
24
  static ɵfac: i0.ɵɵFactoryDeclaration<DaffTabLabelComponent, never>;
19
25
  static ɵcmp: i0.ɵɵComponentDeclaration<DaffTabLabelComponent, "daff-tab-label", never, {}, {}, ["_prefix", "_suffix"], ["[daffPrefix]", "*", "[daffSuffix]"], true, never>;
@@ -17,19 +17,27 @@ export declare class DaffTabPanelComponent {
17
17
  */
18
18
  private class;
19
19
  /**
20
+ * @docs-private
21
+ *
20
22
  * Sets the `role` to tabpanel.
21
23
  */
22
24
  role: string;
23
25
  /**
26
+ * @docs-private
27
+ *
24
28
  * `aria-labelledby` for the tab.
25
29
  */
26
30
  ariaLabelledBy: string;
27
31
  /**
32
+ * @docs-private
33
+ *
28
34
  * Sets the `tabindex` to 0.
29
35
  */
30
36
  tabIndex: string;
31
37
  private _id;
32
38
  /**
39
+ * @docs-private
40
+ *
33
41
  * Dynamically binds the tab panel's id to a unique value generated from the associated tab's panelId.
34
42
  */
35
43
  get tabPanelId(): string;
@@ -40,23 +40,26 @@ export declare class DaffTabsComponent implements AfterContentInit, OnInit {
40
40
  */
41
41
  private class;
42
42
  /**
43
+ * @docs-private
44
+ *
43
45
  * The currently selected tab. This property is dynamically updated when a user selects a tab.
44
46
  */
45
47
  selectedTab: string;
46
48
  /**
47
- * The tab that is initially selected on initial load. If it's not used, the first tab in the tablist will be selected by default.
49
+ * The tab that is selected on initial load. If it's not used, the first tab in the tablist will be selected by default.
48
50
  */
49
51
  initiallySelected: string;
50
52
  /**
51
- * @docs-private
53
+ * aria-label for the tab.
52
54
  */
53
55
  private externalAriaLabel;
54
56
  /**
55
- * aria-label for the tab.
57
+ * @docs-private
58
+ *
56
59
  */
57
60
  ariaLabel: string;
58
61
  /**
59
- * Replace the tab buttons with links.
62
+ * Replace the tab buttons as links.
60
63
  */
61
64
  linkMode: boolean;
62
65
  /**
@@ -84,8 +87,12 @@ export declare class DaffTabsComponent implements AfterContentInit, OnInit {
84
87
  * @docs-private
85
88
  */
86
89
  _tabActivators: QueryList<DaffTabActivatorComponent>;
90
+ /**
91
+ * @docs-private
92
+ */
87
93
  get currentPath(): string;
88
94
  constructor(cdRef: ChangeDetectorRef, location: Location);
95
+ private reset;
89
96
  /**
90
97
  * @docs-private
91
98
  */
@@ -95,6 +102,8 @@ export declare class DaffTabsComponent implements AfterContentInit, OnInit {
95
102
  */
96
103
  ngAfterContentInit(): void;
97
104
  /**
105
+ * @docs-private
106
+ *
98
107
  * Selects a tab and sets focus on the selected tab.
99
108
  */
100
109
  select(tabId: string): void;
@@ -108,18 +117,26 @@ export declare class DaffTabsComponent implements AfterContentInit, OnInit {
108
117
  */
109
118
  _buildQueryParams(tab: string): Params;
110
119
  /**
120
+ * @docs-private
121
+ *
111
122
  * Selects the previous tab and wraps around to the last tab if the first tab is currently selected.
112
123
  */
113
124
  previous(): void;
114
125
  /**
126
+ * @docs-private
127
+ *
115
128
  * Selects the next tab and wraps around to the first tab if the last tab is currently selected.
116
129
  */
117
130
  next(): void;
118
131
  /**
132
+ * @docs-private
133
+ *
119
134
  * Selects the first tab.
120
135
  */
121
136
  selectFirst(event: KeyboardEvent | null): void;
122
137
  /**
138
+ * @docs-private
139
+ *
123
140
  * Selects the last tab.
124
141
  */
125
142
  selectLast(event: KeyboardEvent | null): void;