@porsche-design-system/components-angular 4.5.0 → 4.6.0-rc.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 (283) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/bin/pds-skill.js +259 -0
  3. package/fesm2022/porsche-design-system-components-angular.mjs.map +1 -1
  4. package/package.json +5 -2
  5. package/skill/SKILL.md +124 -0
  6. package/skill/references/components/p-accordion/examples/Default.ts +26 -0
  7. package/skill/references/components/p-accordion/examples/InteractiveElementsInSummary.ts +30 -0
  8. package/skill/references/components/p-accordion/examples/StickySummary.ts +26 -0
  9. package/skill/references/components/p-accordion/p-accordion.md +95 -0
  10. package/skill/references/components/p-ai-tag/examples/Default.ts +13 -0
  11. package/skill/references/components/p-ai-tag/examples/WithinCheckbox.ts +33 -0
  12. package/skill/references/components/p-ai-tag/examples/WithinFormLabel.ts +40 -0
  13. package/skill/references/components/p-ai-tag/examples/WithinImage.ts +16 -0
  14. package/skill/references/components/p-ai-tag/examples/WithinInputSearch.ts +15 -0
  15. package/skill/references/components/p-ai-tag/examples/WithinRadioGroup.ts +32 -0
  16. package/skill/references/components/p-ai-tag/examples/WithinTable.ts +94 -0
  17. package/skill/references/components/p-ai-tag/examples/WithinText.ts +17 -0
  18. package/skill/references/components/p-ai-tag/p-ai-tag.md +47 -0
  19. package/skill/references/components/p-banner/examples/Customization.ts +37 -0
  20. package/skill/references/components/p-banner/examples/Default.ts +26 -0
  21. package/skill/references/components/p-banner/p-banner.md +92 -0
  22. package/skill/references/components/p-button/examples/Default.ts +15 -0
  23. package/skill/references/components/p-button/examples/Form.ts +26 -0
  24. package/skill/references/components/p-button/examples/FormAttribute.ts +30 -0
  25. package/skill/references/components/p-button/p-button.md +118 -0
  26. package/skill/references/components/p-button-pure/examples/CustomClickableArea.ts +15 -0
  27. package/skill/references/components/p-button-pure/examples/Default.ts +15 -0
  28. package/skill/references/components/p-button-pure/examples/Form.ts +26 -0
  29. package/skill/references/components/p-button-pure/examples/FormAttribute.ts +30 -0
  30. package/skill/references/components/p-button-pure/p-button-pure.md +118 -0
  31. package/skill/references/components/p-button-tile/examples/ColorScheme.ts +18 -0
  32. package/skill/references/components/p-button-tile/examples/Default.ts +21 -0
  33. package/skill/references/components/p-button-tile/examples/FooterSlot.ts +32 -0
  34. package/skill/references/components/p-button-tile/examples/Hyphens.ts +38 -0
  35. package/skill/references/components/p-button-tile/examples/UiBehaviour.ts +44 -0
  36. package/skill/references/components/p-button-tile/p-button-tile.md +115 -0
  37. package/skill/references/components/p-canvas/examples/Default.ts +13 -0
  38. package/skill/references/components/p-canvas/p-canvas.md +91 -0
  39. package/skill/references/components/p-carousel/examples/Default.ts +26 -0
  40. package/skill/references/components/p-carousel/examples/DynamicSlides.ts +37 -0
  41. package/skill/references/components/p-carousel/examples/FlexibleWidths.ts +32 -0
  42. package/skill/references/components/p-carousel/examples/FocusOnCenterSlide.ts +65 -0
  43. package/skill/references/components/p-carousel/examples/Intl.ts +23 -0
  44. package/skill/references/components/p-carousel/examples/JumpToSlide.ts +50 -0
  45. package/skill/references/components/p-carousel/p-carousel.md +142 -0
  46. package/skill/references/components/p-checkbox/examples/Default.ts +13 -0
  47. package/skill/references/components/p-checkbox/examples/Form.ts +31 -0
  48. package/skill/references/components/p-checkbox/examples/Indeterminate.ts +16 -0
  49. package/skill/references/components/p-checkbox/examples/Slots.ts +57 -0
  50. package/skill/references/components/p-checkbox/examples/WrappedLabel.ts +27 -0
  51. package/skill/references/components/p-checkbox/p-checkbox.md +122 -0
  52. package/skill/references/components/p-crest/examples/CustomClickableArea.ts +13 -0
  53. package/skill/references/components/p-crest/examples/Default.ts +13 -0
  54. package/skill/references/components/p-crest/examples/Link.ts +13 -0
  55. package/skill/references/components/p-crest/p-crest.md +65 -0
  56. package/skill/references/components/p-display/examples/Color.ts +15 -0
  57. package/skill/references/components/p-display/examples/Default.ts +15 -0
  58. package/skill/references/components/p-display/examples/Semantics.ts +21 -0
  59. package/skill/references/components/p-display/examples/Size.ts +15 -0
  60. package/skill/references/components/p-display/examples/SizeResponsive.ts +15 -0
  61. package/skill/references/components/p-display/p-display.md +78 -0
  62. package/skill/references/components/p-divider/examples/Default.ts +13 -0
  63. package/skill/references/components/p-divider/examples/Responsive.ts +15 -0
  64. package/skill/references/components/p-divider/examples/Vertical.ts +15 -0
  65. package/skill/references/components/p-divider/p-divider.md +49 -0
  66. package/skill/references/components/p-drilldown/examples/CustomContent.ts +166 -0
  67. package/skill/references/components/p-drilldown/examples/Default.ts +119 -0
  68. package/skill/references/components/p-drilldown/p-drilldown.md +168 -0
  69. package/skill/references/components/p-fieldset/examples/Default.ts +15 -0
  70. package/skill/references/components/p-fieldset/examples/Required.ts +16 -0
  71. package/skill/references/components/p-fieldset/examples/SlottedLabel.ts +18 -0
  72. package/skill/references/components/p-fieldset/examples/SlottedMessage.ts +18 -0
  73. package/skill/references/components/p-fieldset/p-fieldset.md +88 -0
  74. package/skill/references/components/p-flag/examples/Default.ts +13 -0
  75. package/skill/references/components/p-flag/examples/ResponsiveSize.ts +13 -0
  76. package/skill/references/components/p-flag/examples/Size.ts +16 -0
  77. package/skill/references/components/p-flag/examples/SizeCssVar.ts +13 -0
  78. package/skill/references/components/p-flag/p-flag.md +68 -0
  79. package/skill/references/components/p-flyout/examples/CustomStyling.ts +47 -0
  80. package/skill/references/components/p-flyout/examples/Default.ts +44 -0
  81. package/skill/references/components/p-flyout/examples/Form.ts +47 -0
  82. package/skill/references/components/p-flyout/examples/StickyTop.ts +44 -0
  83. package/skill/references/components/p-flyout/p-flyout.md +128 -0
  84. package/skill/references/components/p-heading/examples/Color.ts +15 -0
  85. package/skill/references/components/p-heading/examples/Default.ts +15 -0
  86. package/skill/references/components/p-heading/examples/Semantics.ts +21 -0
  87. package/skill/references/components/p-heading/p-heading.md +78 -0
  88. package/skill/references/components/p-icon/examples/Color.ts +16 -0
  89. package/skill/references/components/p-icon/examples/ColorCssVar.ts +13 -0
  90. package/skill/references/components/p-icon/examples/Custom.ts +13 -0
  91. package/skill/references/components/p-icon/examples/Default.ts +13 -0
  92. package/skill/references/components/p-icon/examples/Overview.ts +591 -0
  93. package/skill/references/components/p-icon/examples/ResponsiveSize.ts +13 -0
  94. package/skill/references/components/p-icon/examples/Size.ts +16 -0
  95. package/skill/references/components/p-icon/examples/SizeCssVar.ts +13 -0
  96. package/skill/references/components/p-icon/p-icon.md +88 -0
  97. package/skill/references/components/p-inline-notification/examples/ActionButton.ts +29 -0
  98. package/skill/references/components/p-inline-notification/examples/Default.ts +13 -0
  99. package/skill/references/components/p-inline-notification/examples/EventHandling.ts +31 -0
  100. package/skill/references/components/p-inline-notification/p-inline-notification.md +74 -0
  101. package/skill/references/components/p-input-date/examples/Default.ts +13 -0
  102. package/skill/references/components/p-input-date/examples/Form.ts +31 -0
  103. package/skill/references/components/p-input-date/examples/Slots.ts +44 -0
  104. package/skill/references/components/p-input-date/p-input-date.md +138 -0
  105. package/skill/references/components/p-input-email/examples/Default.ts +13 -0
  106. package/skill/references/components/p-input-email/examples/Form.ts +31 -0
  107. package/skill/references/components/p-input-email/examples/Slots.ts +44 -0
  108. package/skill/references/components/p-input-email/p-input-email.md +142 -0
  109. package/skill/references/components/p-input-month/examples/Default.ts +13 -0
  110. package/skill/references/components/p-input-month/examples/Form.ts +31 -0
  111. package/skill/references/components/p-input-month/examples/Slots.ts +44 -0
  112. package/skill/references/components/p-input-month/p-input-month.md +138 -0
  113. package/skill/references/components/p-input-number/examples/Default.ts +13 -0
  114. package/skill/references/components/p-input-number/examples/Form.ts +31 -0
  115. package/skill/references/components/p-input-number/examples/Slots.ts +44 -0
  116. package/skill/references/components/p-input-number/p-input-number.md +146 -0
  117. package/skill/references/components/p-input-password/examples/Default.ts +13 -0
  118. package/skill/references/components/p-input-password/examples/Form.ts +31 -0
  119. package/skill/references/components/p-input-password/examples/Slots.ts +42 -0
  120. package/skill/references/components/p-input-password/examples/Toggle.ts +13 -0
  121. package/skill/references/components/p-input-password/p-input-password.md +141 -0
  122. package/skill/references/components/p-input-search/examples/AriaCombobox.ts +38 -0
  123. package/skill/references/components/p-input-search/examples/Default.ts +13 -0
  124. package/skill/references/components/p-input-search/examples/Form.ts +31 -0
  125. package/skill/references/components/p-input-search/examples/Slots.ts +44 -0
  126. package/skill/references/components/p-input-search/p-input-search.md +178 -0
  127. package/skill/references/components/p-input-tel/examples/Default.ts +13 -0
  128. package/skill/references/components/p-input-tel/examples/Form.ts +31 -0
  129. package/skill/references/components/p-input-tel/examples/Slots.ts +44 -0
  130. package/skill/references/components/p-input-tel/p-input-tel.md +141 -0
  131. package/skill/references/components/p-input-text/examples/Controlled.ts +36 -0
  132. package/skill/references/components/p-input-text/examples/Default.ts +13 -0
  133. package/skill/references/components/p-input-text/examples/Form.ts +31 -0
  134. package/skill/references/components/p-input-text/examples/Slots.ts +44 -0
  135. package/skill/references/components/p-input-text/p-input-text.md +146 -0
  136. package/skill/references/components/p-input-time/examples/Default.ts +13 -0
  137. package/skill/references/components/p-input-time/examples/Form.ts +31 -0
  138. package/skill/references/components/p-input-time/examples/Slots.ts +44 -0
  139. package/skill/references/components/p-input-time/p-input-time.md +140 -0
  140. package/skill/references/components/p-input-url/examples/Default.ts +13 -0
  141. package/skill/references/components/p-input-url/examples/Form.ts +31 -0
  142. package/skill/references/components/p-input-url/examples/Slots.ts +44 -0
  143. package/skill/references/components/p-input-url/p-input-url.md +141 -0
  144. package/skill/references/components/p-input-week/examples/Default.ts +13 -0
  145. package/skill/references/components/p-input-week/examples/Form.ts +31 -0
  146. package/skill/references/components/p-input-week/examples/Slots.ts +44 -0
  147. package/skill/references/components/p-input-week/p-input-week.md +138 -0
  148. package/skill/references/components/p-link/examples/Default.ts +15 -0
  149. package/skill/references/components/p-link/examples/FrameworkRouting.ts +17 -0
  150. package/skill/references/components/p-link/examples/Icon.ts +20 -0
  151. package/skill/references/components/p-link/p-link.md +101 -0
  152. package/skill/references/components/p-link-pure/examples/CustomClickableArea.ts +15 -0
  153. package/skill/references/components/p-link-pure/examples/Default.ts +15 -0
  154. package/skill/references/components/p-link-pure/examples/FrameworkRouting.ts +17 -0
  155. package/skill/references/components/p-link-pure/examples/Icon.ts +20 -0
  156. package/skill/references/components/p-link-pure/p-link-pure.md +110 -0
  157. package/skill/references/components/p-link-tile/examples/ColorScheme.ts +18 -0
  158. package/skill/references/components/p-link-tile/examples/Default.ts +21 -0
  159. package/skill/references/components/p-link-tile/examples/FooterSlot.ts +32 -0
  160. package/skill/references/components/p-link-tile/examples/Hyphens.ts +39 -0
  161. package/skill/references/components/p-link-tile/examples/UiBehaviour.ts +44 -0
  162. package/skill/references/components/p-link-tile/examples/WithVideo.ts +18 -0
  163. package/skill/references/components/p-link-tile/p-link-tile.md +105 -0
  164. package/skill/references/components/p-link-tile-product/examples/Default.ts +24 -0
  165. package/skill/references/components/p-link-tile-product/examples/FrameworkRouting.ts +27 -0
  166. package/skill/references/components/p-link-tile-product/p-link-tile-product.md +93 -0
  167. package/skill/references/components/p-modal/examples/AlertDialog.ts +41 -0
  168. package/skill/references/components/p-modal/examples/CustomStyling.ts +28 -0
  169. package/skill/references/components/p-modal/examples/Default.ts +41 -0
  170. package/skill/references/components/p-modal/examples/Scrollable.ts +45 -0
  171. package/skill/references/components/p-modal/p-modal.md +135 -0
  172. package/skill/references/components/p-model-signature/examples/CustomStyling.ts +17 -0
  173. package/skill/references/components/p-model-signature/examples/Default.ts +13 -0
  174. package/skill/references/components/p-model-signature/examples/MaskBlendMode.ts +35 -0
  175. package/skill/references/components/p-model-signature/examples/MaskImage.ts +15 -0
  176. package/skill/references/components/p-model-signature/examples/MaskVideo.ts +15 -0
  177. package/skill/references/components/p-model-signature/examples/SafeZone.ts +63 -0
  178. package/skill/references/components/p-model-signature/p-model-signature.md +62 -0
  179. package/skill/references/components/p-multi-select/examples/AsyncFilter.ts +149 -0
  180. package/skill/references/components/p-multi-select/examples/Default.ts +32 -0
  181. package/skill/references/components/p-multi-select/examples/Form.ts +38 -0
  182. package/skill/references/components/p-multi-select/examples/Optgroups.ts +45 -0
  183. package/skill/references/components/p-multi-select/examples/SelectedSlot.ts +103 -0
  184. package/skill/references/components/p-multi-select/examples/SetValue.ts +76 -0
  185. package/skill/references/components/p-multi-select/examples/Slots.ts +51 -0
  186. package/skill/references/components/p-multi-select/p-multi-select.md +197 -0
  187. package/skill/references/components/p-pagination/examples/Default.ts +13 -0
  188. package/skill/references/components/p-pagination/p-pagination.md +83 -0
  189. package/skill/references/components/p-pin-code/examples/CopyPaste.ts +13 -0
  190. package/skill/references/components/p-pin-code/examples/Default.ts +13 -0
  191. package/skill/references/components/p-pin-code/examples/Form.ts +31 -0
  192. package/skill/references/components/p-pin-code/examples/Slots.ts +42 -0
  193. package/skill/references/components/p-pin-code/p-pin-code.md +109 -0
  194. package/skill/references/components/p-popover/examples/Default.ts +17 -0
  195. package/skill/references/components/p-popover/examples/SlottedButton.ts +18 -0
  196. package/skill/references/components/p-popover/p-popover.md +116 -0
  197. package/skill/references/components/p-radio-group/examples/Default.ts +20 -0
  198. package/skill/references/components/p-radio-group/examples/Form.ts +38 -0
  199. package/skill/references/components/p-radio-group/examples/Slots.ts +72 -0
  200. package/skill/references/components/p-radio-group/p-radio-group.md +157 -0
  201. package/skill/references/components/p-scroller/examples/Default.ts +54 -0
  202. package/skill/references/components/p-scroller/examples/Height.ts +29 -0
  203. package/skill/references/components/p-scroller/examples/ScrollToPosition.ts +43 -0
  204. package/skill/references/components/p-scroller/p-scroller.md +93 -0
  205. package/skill/references/components/p-segmented-control/examples/Default.ts +29 -0
  206. package/skill/references/components/p-segmented-control/examples/Form.ts +37 -0
  207. package/skill/references/components/p-segmented-control/examples/Slots.ts +57 -0
  208. package/skill/references/components/p-segmented-control/examples/WithLabels.ts +29 -0
  209. package/skill/references/components/p-segmented-control/p-segmented-control.md +162 -0
  210. package/skill/references/components/p-select/examples/AsyncFilter.ts +149 -0
  211. package/skill/references/components/p-select/examples/Default.ts +32 -0
  212. package/skill/references/components/p-select/examples/Form.ts +38 -0
  213. package/skill/references/components/p-select/examples/Optgroups.ts +45 -0
  214. package/skill/references/components/p-select/examples/Required.ts +48 -0
  215. package/skill/references/components/p-select/examples/SelectedSlot.ts +130 -0
  216. package/skill/references/components/p-select/examples/SetValue.ts +71 -0
  217. package/skill/references/components/p-select/examples/Slots.ts +51 -0
  218. package/skill/references/components/p-select/examples/SlottedImages.ts +38 -0
  219. package/skill/references/components/p-select/p-select.md +194 -0
  220. package/skill/references/components/p-sheet/examples/Default.ts +33 -0
  221. package/skill/references/components/p-sheet/p-sheet.md +121 -0
  222. package/skill/references/components/p-spinner/examples/Color.ts +16 -0
  223. package/skill/references/components/p-spinner/examples/ColorCssVar.ts +13 -0
  224. package/skill/references/components/p-spinner/examples/Default.ts +13 -0
  225. package/skill/references/components/p-spinner/examples/ResponsiveSize.ts +13 -0
  226. package/skill/references/components/p-spinner/examples/Size.ts +16 -0
  227. package/skill/references/components/p-spinner/examples/SizeCssVar.ts +13 -0
  228. package/skill/references/components/p-spinner/p-spinner.md +96 -0
  229. package/skill/references/components/p-stepper-horizontal/examples/Default.ts +26 -0
  230. package/skill/references/components/p-stepper-horizontal/examples/FrameworkImplementation.ts +107 -0
  231. package/skill/references/components/p-stepper-horizontal/p-stepper-horizontal.md +109 -0
  232. package/skill/references/components/p-switch/examples/Default.ts +21 -0
  233. package/skill/references/components/p-switch/p-switch.md +103 -0
  234. package/skill/references/components/p-table/examples/Advanced.ts +162 -0
  235. package/skill/references/components/p-table/examples/CaptionProperty.ts +40 -0
  236. package/skill/references/components/p-table/examples/CaptionSlot.ts +43 -0
  237. package/skill/references/components/p-table/examples/Default.ts +120 -0
  238. package/skill/references/components/p-table/examples/HideLabel.ts +40 -0
  239. package/skill/references/components/p-table/examples/LayoutFixed.ts +53 -0
  240. package/skill/references/components/p-table/examples/Sorting.ts +79 -0
  241. package/skill/references/components/p-table/p-table.md +189 -0
  242. package/skill/references/components/p-tabs/examples/ActiveTab.ts +29 -0
  243. package/skill/references/components/p-tabs/examples/Default.ts +29 -0
  244. package/skill/references/components/p-tabs/examples/Gradient.ts +114 -0
  245. package/skill/references/components/p-tabs/examples/Labelling.ts +29 -0
  246. package/skill/references/components/p-tabs/p-tabs.md +136 -0
  247. package/skill/references/components/p-tabs-bar/examples/Default.ts +29 -0
  248. package/skill/references/components/p-tabs-bar/examples/Gradient.ts +80 -0
  249. package/skill/references/components/p-tabs-bar/examples/Labelling.ts +29 -0
  250. package/skill/references/components/p-tabs-bar/examples/Links.ts +23 -0
  251. package/skill/references/components/p-tabs-bar/p-tabs-bar.md +181 -0
  252. package/skill/references/components/p-tag/examples/Default.ts +15 -0
  253. package/skill/references/components/p-tag/examples/Multiline.ts +17 -0
  254. package/skill/references/components/p-tag/examples/SlottedButton.ts +44 -0
  255. package/skill/references/components/p-tag/examples/SlottedLink.ts +44 -0
  256. package/skill/references/components/p-tag/p-tag.md +66 -0
  257. package/skill/references/components/p-tag-dismissible/examples/Default.ts +15 -0
  258. package/skill/references/components/p-tag-dismissible/p-tag-dismissible.md +75 -0
  259. package/skill/references/components/p-text/examples/Default.ts +15 -0
  260. package/skill/references/components/p-text/examples/Semantics.ts +21 -0
  261. package/skill/references/components/p-text/examples/Size.ts +15 -0
  262. package/skill/references/components/p-text/examples/SizeResponsive.ts +15 -0
  263. package/skill/references/components/p-text/p-text.md +68 -0
  264. package/skill/references/components/p-text-list/examples/Default.ts +31 -0
  265. package/skill/references/components/p-text-list/p-text-list.md +68 -0
  266. package/skill/references/components/p-textarea/examples/Default.ts +13 -0
  267. package/skill/references/components/p-textarea/examples/Form.ts +31 -0
  268. package/skill/references/components/p-textarea/examples/Slots.ts +42 -0
  269. package/skill/references/components/p-textarea/p-textarea.md +122 -0
  270. package/skill/references/components/p-toast/examples/Default.ts +23 -0
  271. package/skill/references/components/p-toast/p-toast.md +61 -0
  272. package/skill/references/components/p-wordmark/examples/CustomClickableArea.ts +13 -0
  273. package/skill/references/components/p-wordmark/examples/Default.ts +13 -0
  274. package/skill/references/components/p-wordmark/examples/Size.ts +13 -0
  275. package/skill/references/components/p-wordmark/p-wordmark.md +66 -0
  276. package/skill/references/icons.md +5 -0
  277. package/skill/references/styles/emotion.md +439 -0
  278. package/skill/references/styles/scss.md +402 -0
  279. package/skill/references/styles/tailwindcss.md +356 -0
  280. package/skill/references/styles/vanilla-extract.md +444 -0
  281. package/skill/references/stylesheets.md +331 -0
  282. package/skill/references/tokens.md +323 -0
  283. package/types/porsche-design-system-components-angular.d.ts +2 -2
@@ -0,0 +1,18 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-fieldset>
8
+ <span slot="label">
9
+ Some legend label
10
+ </span>
11
+ <p-input-text label="Some label" name="some-name"></p-input-text>
12
+ </p-fieldset>
13
+ `,
14
+ changeDetection: ChangeDetectionStrategy.OnPush,
15
+ standalone: true,
16
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
17
+ })
18
+ export class ExampleComponent {}
@@ -0,0 +1,18 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-fieldset label="Some legend label" state="error">
8
+ <p-input-text label="Some label" name="some-name"></p-input-text>
9
+ <span slot="message">
10
+ Some error message
11
+ </span>
12
+ </p-fieldset>
13
+ `,
14
+ changeDetection: ChangeDetectionStrategy.OnPush,
15
+ standalone: true,
16
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
17
+ })
18
+ export class ExampleComponent {}
@@ -0,0 +1,88 @@
1
+ # p-fieldset
2
+
3
+ The `p-fieldset` is a grouping component for wrapping contextual associated form elements. Its visible part is an HTML *legend* element, which can be seen like a headline for describing the meaning of a form block. You can see some usage examples on our [form patterns section](https://designsystem.porsche.com/patterns/forms/resources/).
4
+
5
+ ## Usage
6
+
7
+ ### Do:
8
+
9
+ - Use to group related fields together to make them more organized and easier to understand for users.
10
+ - Use descriptive and clear labels for the field sets to help users quickly understand what information is being requested.
11
+ - Use for grouping several form controls as well as labels within a form.
12
+ - Use it for grouping several checkboxes.
13
+ - Use it for creating a date picker.
14
+ - Use consistent formatting and styling for field sets to maintain visual consistency and improve the overall user experience.
15
+ - Use field sets to control the visibility of groups of fields that are not always necessary, such as advanced options or additional information.
16
+ - Test your field sets with users to ensure they are effective in improving the usability of your forms or page layouts.
17
+
18
+ ### Don't:
19
+
20
+ - Don't use too many field sets on a single form or page layout.
21
+ - Don't use to hide important information or fields that users need to complete a form.
22
+ - Don't rely solely on field sets to improve the usability of your forms or page layouts.
23
+
24
+ ---
25
+
26
+ ## Behavior
27
+
28
+ ### Sections including form elements
29
+
30
+ [Form pattern guideline](https://designsystem.porsche.com/patterns/forms).
31
+
32
+ ## Accessibility support
33
+
34
+ ### ARIA enhancements
35
+
36
+ #### External **ARIA** provided by the `aria` property:
37
+
38
+ | ARIA | Usage |
39
+ | --- | --- |
40
+ | `role="radiogroup"` | Changes the default role of `group` to `radiogroup` |
41
+
42
+ #### Internal **ARIA** that is managed by the component:
43
+
44
+ | ARIA | Usage |
45
+ | --- | --- |
46
+ | `role="alert"` | When content is populated or changed in `state="error"`, the component announces it immediately. |
47
+ | `aria-required="true"` | Indicates if all children of the fieldset group are required. |
48
+ | `aria-invalid="true"` | If `error` state is set. |
49
+ | `aria-describedby="IDREF"` | References the accessible description when `state` message is provided. |
50
+
51
+ ## Development considerations
52
+
53
+ ### Common do's and don'ts
54
+
55
+ - **Do** provide a clear `label` that describes the grouped fields.
56
+ - **Do** use the component state/message API so group validation is announced.
57
+ - **Do** use `aria="{ 'role': 'radiogroup' }"` only when the fieldset contains custom radio controls.
58
+ - **Don't** set `state="error"` without a descriptive `message`.
59
+
60
+ ## API
61
+
62
+ ### Properties
63
+
64
+ | Property | Type | Default | Description |
65
+ | --- | --- | --- | --- |
66
+ | `aria` | `'radiogroup'` | `undefined` | Overrides the ARIA role on the fieldset — use `radiogroup` when grouping radio buttons. |
67
+ | `label` | `string` | `''` | Sets the visible legend text displayed above the grouped form controls. |
68
+ | `labelSize` | `'small'` `'medium'` | `'medium'` | Sets the font size of the fieldset label (`small`, `medium`, or `large`). |
69
+ | `message` | `string` | `''` | Sets the validation feedback message displayed below the fieldset when `state` is `success` or `error`. |
70
+ | `required` | `boolean` | `false` | Marks all controls within the fieldset as required and adds a required indicator to the label. |
71
+ | `state` | `'none'` `'error'` `'success'` | `'none'` | Sets the validation state of the fieldset, controlling the color and style of the feedback message. |
72
+
73
+ ### Slots
74
+
75
+ | Slot | Required | Allowed tag names | Description |
76
+ | --- | --- | --- | --- |
77
+ | `label` | no | — | Shows a label. Only [phrasing content](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_categories#Phrasing_content) is allowed. |
78
+ | _(default)_ | no | — | Default slot for the main content. |
79
+ | `message` | no | — | Shows a state message. Only [phrasing content](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_categories#Phrasing_content) is allowed. |
80
+
81
+ ## Examples
82
+
83
+ | Example | When to use | File |
84
+ | --- | --- | --- |
85
+ | Default | Minimal default configuration. | [./examples/Default.ts](./examples/Default.ts) |
86
+ | Slotted label | Slotted label | [./examples/SlottedLabel.ts](./examples/SlottedLabel.ts) |
87
+ | Slotted message | Slotted message | [./examples/SlottedMessage.ts](./examples/SlottedMessage.ts) |
88
+ | Required | Setting `required="true"` on `p-fieldset` only renders the asterisk on the legend and sets `aria-required` on the underlying `<fieldset>` element. | [./examples/Required.ts](./examples/Required.ts) |
@@ -0,0 +1,13 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-flag [aria]="{'aria-label': 'Flag of Germany'}"></p-flag>
8
+ `,
9
+ changeDetection: ChangeDetectionStrategy.OnPush,
10
+ standalone: true,
11
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
12
+ })
13
+ export class ExampleComponent {}
@@ -0,0 +1,13 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-flag name="de" [size]="{'base': 'sm', 'l': '2xl'}" [aria]="{'aria-label': 'Flag of Germany'}"></p-flag>
8
+ `,
9
+ changeDetection: ChangeDetectionStrategy.OnPush,
10
+ standalone: true,
11
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
12
+ })
13
+ export class ExampleComponent {}
@@ -0,0 +1,16 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-text class="text-[48px]" size="inherit">
8
+ <p-flag class="me-static-sm" size="inherit" name="de" [aria]="{'aria-label': 'Flag of Germany'}"></p-flag>
9
+ Some text
10
+ </p-text>
11
+ `,
12
+ changeDetection: ChangeDetectionStrategy.OnPush,
13
+ standalone: true,
14
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
15
+ })
16
+ export class ExampleComponent {}
@@ -0,0 +1,13 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-flag class="[--p-flag-size:48px]" name="de" [aria]="{'aria-label': 'Flag of Germany'}"></p-flag>
8
+ `,
9
+ changeDetection: ChangeDetectionStrategy.OnPush,
10
+ standalone: true,
11
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
12
+ })
13
+ export class ExampleComponent {}
@@ -0,0 +1,68 @@
1
+ # p-flag
2
+
3
+ The `p-flag` component displays a country or region flag and should be used to communicate geographic context visually.
4
+
5
+ Flags are universally recognized symbols that enable rapid visual communication. Alongside icons, colors, and typography, they are a fundamental part of the Porsche design language and help create a seamless user experience.
6
+
7
+ ## Usage
8
+
9
+ The following guidelines provide instructions for designers and developers on the appropriate use of the `flag` component for effective communication and user experience.
10
+
11
+ ### Do:
12
+
13
+ - **Use the `flag` component for country identification.** The primary purpose is to represent a nation, such as specifying a user's country of origin, shipping location, or detailing product availability.
14
+
15
+ - **Pair the flag with a label for clarity.** While flags are great for quick visual recognition, they can be ambiguous. Always accompany a flag with a country name or an appropriate label to avoid confusion.
16
+
17
+ - **Use the two-letter ISO 3166-1 alpha-2 code.** This standard ensures consistency, reduces errors, and makes it easier to integrate with other systems and APIs.
18
+
19
+ ### Don't:
20
+
21
+ - **Don't use flags to represent a language.** Many languages are spoken in multiple countries (e.g., Spanish). A flag represents a nation, not a language. Use language codes or names instead.
22
+
23
+ - **Don't use flags to represent an emotion or concept.** Flags are powerful symbols of national identity. Using them as generic icons can dilute their meaning and cause user confusion.
24
+
25
+ - **Don't rely solely on the flag icon.** Always provide an aria-label for accessibility. Screen readers cannot interpret flags, and without a descriptive label, you create an inaccessible user experience.
26
+
27
+ ## Accessibility support
28
+
29
+ ### ARIA enhancements
30
+
31
+ #### External **ARIA** provided by the `aria` property:
32
+
33
+ | ARIA | Usage |
34
+ | --- | --- |
35
+ | `aria-label` | Defines a string value that labels the element (through the `alt` attribute). |
36
+
37
+ ## Development considerations
38
+
39
+ ### Common do's and don'ts
40
+
41
+ - **Do** pass a country or region name through the `aria` prop when the flag conveys meaning.
42
+ - **Do** hide decorative flags from assistive technologies when adjacent text already names the country or region.
43
+ - **Don't** leave informative flags without an accessible name.
44
+
45
+ ## API
46
+
47
+ ### Properties
48
+
49
+ | Property | Type | Default | Description |
50
+ | --- | --- | --- | --- |
51
+ | `aria` | `FlagAriaAttribute` | `undefined` | A map of ARIA attributes to enhance the flag's accessibility. For example, use `{ 'aria-label': 'German flag' }` to provide a descriptive label for screen readers. |
52
+ | `name` | `'ad'` `'ae'` `'al'` `'am'` `'ar'` `'at'` `'au'` `'az'` `'ba'` `'bd'` `'be'` `'bg'` `'bh'` `'bn'` `'bo'` `'br'` `'by'` `'ca'` `'ch'` `'cl'` `'cn'` `'co'` `'cr'` `'cw'` `'cy'` `'cz'` `'de'` `'dk'` `'do'` `'dz'` `'ec'` `'ee'` `'eg'` `'es'` `'fi'` `'fr'` `'gb'` `'ge'` `'gh'` `'gi'` `'gr'` `'gt'` `'hk'` `'hn'` `'hr'` `'ht'` `'hu'` `'id'` `'ie'` `'il'` `'in'` `'is'` `'it'` `'jm'` `'jo'` `'jp'` `'ke'` `'kh'` `'kr'` `'kw'` `'kz'` `'lb'` `'li'` `'lk'` `'lt'` `'lu'` `'lv'` `'ma'` `'mc'` `'md'` `'me'` `'mk'` `'mn'` `'mo'` `'mq'` `'mt'` `'mu'` `'mx'` `'my'` `'ng'` `'nl'` `'no'` `'nz'` `'om'` `'pa'` `'pe'` `'pf'` `'ph'` `'pk'` `'pl'` `'pr'` `'pt'` `'py'` `'qa'` `'re'` `'ro'` `'rs'` `'ru'` `'sa'` `'se'` `'sg'` `'si'` `'sk'` `'sv'` `'th'` `'tn'` `'tr'` `'tt'` `'tw'` `'ua'` `'us'` `'uy'` `'uz'` `'ve'` `'vn'` `'xx'` `'za'` | `'de'` | Specifies the country flag to display. Use the two-letter ISO 3166-1 alpha-2 country code. For example, use `us` for the United States, `de` for Germany, `gb` for Great Britain. |
53
+ | `size` | `'2xs'` `'xs'` `'sm'` `'md'` `'lg'` `'xl'` `'2xl'` `'3xl'` `'4xl'` `'5xl'` `'inherit'`<br>_deprecated:_ `'xx-small'` `'x-small'` `'small'` `'medium'` `'large'` `'x-large'` `'xx-large'`<br>`BreakpointCustomizable<FlagSize>` | `'sm'` | Defines the size of the flag, aligned with the typographic scale used by components such as p-icon, p-spinner, p-text, and p-heading. When set to `inherit`, the size is derived from a custom font-size defined on a parent element, calculated against the global line-height (based on `ex`-unit) to remain visually consistent with other typographic-scale-based components. |
54
+
55
+ ### CSS Variables
56
+
57
+ | CSS Variable | Default | Description |
58
+ | --- | --- | --- |
59
+ | `--p-flag-size` | — | Defines the width and height of the flag. Overrides the `size` property when set. |
60
+
61
+ ## Examples
62
+
63
+ | Example | When to use | File |
64
+ | --- | --- | --- |
65
+ | Default | Minimal default configuration. | [./examples/Default.ts](./examples/Default.ts) |
66
+ | Size via Prop | The `size` property offers a set of predefined sizes that cover most use cases. | [./examples/Size.ts](./examples/Size.ts) |
67
+ | Size via CSS Variable | For full control over the flag's dimensions, use the custom CSS variable `--p-flag-size`, which accepts any valid CSS length value. | [./examples/SizeCssVar.ts](./examples/SizeCssVar.ts) |
68
+ | Responsive Size | The `size` property supports `BreakpointCustomizable` values, allowing you to define different sizes for each major breakpoint (`xs`, `s`, `m`, `l`, `xl`). | [./examples/ResponsiveSize.ts](./examples/ResponsiveSize.ts) |
@@ -0,0 +1,47 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-button type="button" [aria]="{'aria-haspopup': 'dialog'}" (click)="onClick()">
8
+ Open Flyout
9
+ </p-button>
10
+
11
+ <p-flyout [open]="open" [aria]="{'aria-label': 'Some Heading'}" footerBehavior="fixed" class="[--p-flyout-width:90vw]" (dismiss)="onDismiss()">
12
+ <div class="-mt-(--ref-p-flyout-pt) -mx-(--ref-p-flyout-px) h-[300px]">
13
+ <img class="w-full h-full object-cover" src="assets/lights.jpg" alt="Some image description" />
14
+ </div>
15
+ <p-display class="mt-fluid-md" size="small" tag="h2">
16
+ Some heading
17
+ </p-display>
18
+ <p-text class="mt-fluid-sm">
19
+ Some paragraph.
20
+ </p-text>
21
+ <div slot="footer" class="grid grid-cols-[auto_1fr_auto] gap-static-sm justify-items-center">
22
+ <p-button-pure icon="arrow-left" type="button" [hideLabel]="true">
23
+ Prev
24
+ </p-button-pure>
25
+ <p-text>
26
+ 1/4
27
+ </p-text>
28
+ <p-button-pure icon="arrow-right" type="button" [hideLabel]="true">
29
+ Next
30
+ </p-button-pure>
31
+ </div>
32
+ </p-flyout>
33
+ `,
34
+ changeDetection: ChangeDetectionStrategy.OnPush,
35
+ standalone: true,
36
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
37
+ })
38
+ export class ExampleComponent {
39
+ open = false;
40
+
41
+ onClick() {
42
+ this.open = true;
43
+ }
44
+ onDismiss() {
45
+ this.open = false;
46
+ }
47
+ }
@@ -0,0 +1,44 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-button type="button" [aria]="{'aria-haspopup': 'dialog'}" (click)="onClick()">
8
+ Open Flyout
9
+ </p-button>
10
+
11
+ <p-flyout [open]="open" [aria]="{'aria-label': 'Some Heading'}" (dismiss)="onDismiss()">
12
+ <p-heading slot="header" size="large" tag="h2">
13
+ Some Heading
14
+ </p-heading>
15
+ <p-text>
16
+ Some Content
17
+ </p-text>
18
+ <div slot="footer">
19
+ <p-button type="button">
20
+ Proceed
21
+ </p-button>
22
+ <p-button type="button" variant="secondary">
23
+ Cancel
24
+ </p-button>
25
+ </div>
26
+ <p-text slot="sub-footer">
27
+ Some additional Sub-Footer
28
+ </p-text>
29
+ </p-flyout>
30
+ `,
31
+ changeDetection: ChangeDetectionStrategy.OnPush,
32
+ standalone: true,
33
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
34
+ })
35
+ export class ExampleComponent {
36
+ open = false;
37
+
38
+ onClick() {
39
+ this.open = true;
40
+ }
41
+ onDismiss() {
42
+ this.open = false;
43
+ }
44
+ }
@@ -0,0 +1,47 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-button type="button" [aria]="{ 'aria-haspopup': 'dialog' }" (click)="onOpen()">Open Flyout</p-button>
8
+ <p-flyout [open]="isFlyoutOpen" (dismiss)="onDismiss()" [aria]="{ 'aria-label': 'Some Heading' }">
9
+ <p-heading slot="header" size="large" tag="h2">Some Heading</p-heading>
10
+ <form id="some-form" (submit)="onSubmit($event)">
11
+ <p-checkbox name="some-checkbox" label="Some Label"></p-checkbox>
12
+ <p-textarea name="some-textarea" label="Some Label"></p-textarea>
13
+ </form>
14
+ <p-button slot="footer" type="submit" form="some-form">Submit</p-button>
15
+ <p-button slot="footer" type="reset" [variant]="'secondary'" form="some-form">Reset</p-button>
16
+ <p-text slot="sub-footer">
17
+ Last submitted data:
18
+ <br/><br/>
19
+ checkbox: {{checkboxValue}}
20
+ <br/>
21
+ textarea: {{textareaValue}}
22
+ </p-text>
23
+ </p-flyout>
24
+ `,
25
+ changeDetection: ChangeDetectionStrategy.OnPush,
26
+ standalone: true,
27
+ imports: [PorscheDesignSystemModule],
28
+ })
29
+ export class ExampleComponent {
30
+ isFlyoutOpen = false;
31
+ checkboxValue: string = 'none';
32
+ textareaValue: string = 'none';
33
+
34
+ onOpen() {
35
+ this.isFlyoutOpen = true;
36
+ }
37
+ onDismiss() {
38
+ this.isFlyoutOpen = false;
39
+ }
40
+
41
+ onSubmit(e: Event): void {
42
+ e.preventDefault();
43
+ const formData = new FormData(e.target as HTMLFormElement);
44
+ this.checkboxValue = formData.get('some-checkbox')?.toString() || 'none';
45
+ this.textareaValue = formData.get('some-textarea')?.toString() || 'none';
46
+ }
47
+ }
@@ -0,0 +1,44 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-button type="button" [aria]="{'aria-haspopup': 'dialog'}" (click)="onClick()">
8
+ Open Flyout
9
+ </p-button>
10
+
11
+ <p-flyout [open]="open" [aria]="{'aria-label': 'Some Heading'}" (dismiss)="onDismiss()">
12
+ <p-heading slot="header" size="large" tag="h2">
13
+ Some Heading
14
+ </p-heading>
15
+ <div class="grid grid-cols-[2fr_1fr] gap-static-md items-start">
16
+ <div class="sticky top-[calc(var(--p-flyout-sticky-top,0)+16px)] p-static-md bg-surface">
17
+ Some sticky element within content relying on --p-flyout-sticky-top
18
+ </div>
19
+ <div>
20
+ <p-text>
21
+ Some Content Begin
22
+ </p-text>
23
+ <div class="w-[10px] h-[120vh] bg-[deeppink]"></div>
24
+ <p-text>
25
+ Some Content End
26
+ </p-text>
27
+ </div>
28
+ </div>
29
+ </p-flyout>
30
+ `,
31
+ changeDetection: ChangeDetectionStrategy.OnPush,
32
+ standalone: true,
33
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
34
+ })
35
+ export class ExampleComponent {
36
+ open = false;
37
+
38
+ onClick() {
39
+ this.open = true;
40
+ }
41
+ onDismiss() {
42
+ this.open = false;
43
+ }
44
+ }
@@ -0,0 +1,128 @@
1
+ # p-flyout
2
+
3
+ The `p-flyout` is a overlay from the left or right side of the screen. It is commonly used as a temporary workspace that allows users to complete tasks without navigating to a new page or as a mobile navigation.
4
+
5
+ It is a controlled component. This grants flexible control over the flyout's behavior especially whether it should stay open after user interaction like submission of a form.
6
+
7
+ > **Scroll-lock**
8
+ >
9
+ > This component sets `overflow: hidden` on the body when opened in order to prevent background scrolling.
10
+ >
11
+ > This doesn't work completely reliable under iOS but is the most stable solution.
12
+ >
13
+ > Feel free to address this issue in an Open Source PR, if you can provide a better solution.
14
+ >
15
+ > **[Current implementation](https://github.com/porsche-design-system/porsche-design-system/blob/main/packages/components/src/utils/setScrollLock.ts)**
16
+
17
+ ## Usage
18
+
19
+ ### Do:
20
+
21
+ - Use a Flyout as a temporary workspace that allows users to complete tasks without navigating to a new page.
22
+ - Use a Flyout for mobile navigation.
23
+ - Adjust Flyout size and alignment with the grid.
24
+ - Use the sticky header for a descriptive heading & optional sub-heading.
25
+ - Use the sticky footer for a call to action.
26
+ - Use the sub-footer slot for additional or less important information such as legals or faqs.
27
+ - Follow button order and positioning guidelines.
28
+ - Use feedback banner for any feedback related to the request.
29
+
30
+ ### Don't:
31
+
32
+ - Don't use to many actions in the sticky footer or header.
33
+ - Don't put important information in the sub-footer slot.
34
+ - Don't use fullscreen Flyout's on desktop.
35
+ - Don't launch a Flyout within a Flyout.
36
+
37
+ ## Accessibility support
38
+
39
+ The `Flyout` component uses the native `dialog` element to provide a modal dialog which comes with browser-specific behavior. As a result, accessibility features may vary across different browsers.
40
+
41
+ ### Keyboard
42
+
43
+ | Key / state | Function |
44
+ | --- | --- |
45
+ | `Tab`, `Shift-Tab` | Moves focus to the next (or previous) focusable element inside the dialog. Focus is trapped (browser behavior). |
46
+ | `ESC` | Closes the dialog. |
47
+ | `focus` on trigger element | The focus is returned to the trigger element after closing the dialog (browser behavior). |
48
+
49
+ ### ARIA enhancements
50
+
51
+ #### External **ARIA** provided by the `aria` property:
52
+
53
+ | ARIA | Usage |
54
+ | --- | --- |
55
+ | `aria-label` | Defines a string value that labels the dialog element. |
56
+
57
+ #### Internal **ARIA** that is managed by the component:
58
+
59
+ | ARIA | Usage |
60
+ | --- | --- |
61
+ | `aria-label="STRING"` | Defines the accessible name if no `aria` property is provided, uses the contents of the header slot and falls back to a fixed name. |
62
+
63
+ ## Development considerations
64
+
65
+ To inform users that the trigger button opens a `dialog`, set `aria-haspopup` on the trigger using the `aria` property. Provide the dialog title through the `header` slot or the flyout `aria` property.
66
+
67
+ ### Common do's and don'ts
68
+
69
+ - **Do** use a semantic trigger (usually a button) with a meaningful accessible name.
70
+ - **Do** set `aria-haspopup` through the trigger component `aria` prop when opening the flyout.
71
+ - **Do** ensure a meaningful title is available via the `header` slot or `aria` property.
72
+ - **Don't** add raw host-level ARIA attributes as a workaround.
73
+ - **Don't** use unclear trigger copy like "Menu" when the flyout purpose is not obvious.
74
+
75
+ ## API
76
+
77
+ ### Properties
78
+
79
+ | Property | Type | Default | Description |
80
+ | --- | --- | --- | --- |
81
+ | `aria` | `FlyoutAriaAttribute` | `undefined` | Sets ARIA attributes on the flyout dialog element for improved screen reader accessibility. |
82
+ | `backdrop` | `'blur'` `'shading'` | `'blur'` | Sets the backdrop style. Use `blur` when background content is irrelevant; use `shading` when users still need visual context. |
83
+ | `background` | `'canvas'` `'surface'` | `'canvas'` | Sets the background color of the flyout panel (`canvas` or `surface`). |
84
+ | `disableBackdropClick` | `boolean` | `false` | When enabled, clicking the backdrop will not close the flyout. |
85
+ | `footerBehavior` | `'sticky'` `'fixed'` | `'sticky'` | Controls footer behavior. `fixed` keeps it anchored at the bottom; `sticky` pins it only when content overflows. |
86
+ | `fullscreen` | `boolean`<br>`BreakpointCustomizable<boolean>` | `false` | If true the flyout stretches to the full viewport width with squared corners. Useful for smaller viewports where the flyout would otherwise fill the screen but still show rounded corners. |
87
+ | `open` _(required)_ | `boolean` | `false` | Controls whether the flyout panel is visible. |
88
+ | `position` | `'start'` `'end'` | `'end'` | Sets the side the flyout slides in from — `start` for left or `end` for right in LTR layouts. |
89
+
90
+ ### Events
91
+
92
+ | Event | Type | Description |
93
+ | --- | --- | --- |
94
+ | `dismiss` | `CustomEvent<void>` | Emitted when the user closes the flyout via the close button, backdrop click, or Escape key. |
95
+ | `motionHiddenEnd` | `CustomEvent<FlyoutMotionHiddenEndEventDetail>`<br>`TransitionEvent` | Emitted after the flyout's close transition completes and the panel is fully hidden. |
96
+ | `motionVisibleEnd` | `CustomEvent<FlyoutMotionVisibleEndEventDetail>`<br>`TransitionEvent` | Emitted after the flyout's open transition completes and the panel is fully visible. |
97
+
98
+ ### Controlled properties
99
+
100
+ - `open` — a controlled prop: the component does **not** update it itself. Handle the `dismiss` event and assign the new value to `open` yourself, or the change will not take effect.
101
+
102
+ ### Slots
103
+
104
+ | Slot | Required | Allowed tag names | Description |
105
+ | --- | --- | --- | --- |
106
+ | `header` | no | — | Renders a sticky header section above the content area. |
107
+ | _(default)_ | no | — | Default slot for the main content. |
108
+ | `footer` | no | — | Shows a sticky footer section, flowing under the content area when scrollable. |
109
+ | `sub-footer` | no | — | Renders additional content below the footer, such as legal information or FAQs. It appears when the flyout has enough space or when the user scrolls to the end. |
110
+
111
+ ### CSS Variables
112
+
113
+ | CSS Variable | Default | Description |
114
+ | --- | --- | --- |
115
+ | `--p-flyout-width` | `auto` | Width of the flyout. |
116
+ | `--p-flyout-sticky-top` | — | @experimental Exposes the header's height as a read-only CSS variable, set automatically by the component. Slotted sticky content can use this value to offset their top position correctly. |
117
+ | `--ref-p-flyout-pt` | — | Exposes the internally used padding-top of the Flyout as read only CSS variable. When slotting e.g. a media container, this variable can be used to stretch the element to the top of the Flyout. |
118
+ | `--ref-p-flyout-pb` | — | Exposes the internally used padding-bottom of the Flyout as read only CSS variable. When slotting e.g. a media container, this variable can be used to stretch the element to the bottom of the Flyout. |
119
+ | `--ref-p-flyout-px` | — | Exposes the internally used padding-inline of the Flyout as read only CSS variable. When slotting e.g. a media container, this variable can be used to stretch the element to the full horizontal size of the Flyout. |
120
+
121
+ ## Examples
122
+
123
+ | Example | When to use | File |
124
+ | --- | --- | --- |
125
+ | Default | Minimal default configuration. | [./examples/Default.ts](./examples/Default.ts) |
126
+ | Sticky content with Custom CSS Property (Experimental) | In order to display some sticky element within the flyout content you can use the experimental `--p-flyout-sticky-top` CSS custom property to account for the height of the header. | [./examples/StickyTop.ts](./examples/StickyTop.ts) |
127
+ | Flyout Form | The following example demonstrates how a form can be used within a flyout component: | [./examples/Form.ts](./examples/Form.ts) |
128
+ | Custom Styling | The Flyout exposes read-only CSS Variables (prefixed with `--ref-`). | [./examples/CustomStyling.ts](./examples/CustomStyling.ts) |
@@ -0,0 +1,15 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-heading tag="h3" color="inherit" class="text-[deeppink]">
8
+ The quick brown fox jumps over the lazy dog
9
+ </p-heading>
10
+ `,
11
+ changeDetection: ChangeDetectionStrategy.OnPush,
12
+ standalone: true,
13
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
14
+ })
15
+ export class ExampleComponent {}
@@ -0,0 +1,15 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-heading>
8
+ The quick brown fox jumps over the lazy dog
9
+ </p-heading>
10
+ `,
11
+ changeDetection: ChangeDetectionStrategy.OnPush,
12
+ standalone: true,
13
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
14
+ })
15
+ export class ExampleComponent {}
@@ -0,0 +1,21 @@
1
+ import { ChangeDetectionStrategy, Component } from '@angular/core';
2
+ import { PorscheDesignSystemModule } from '@porsche-design-system/components-angular';
3
+
4
+ @Component({
5
+ selector: 'porsche-design-system-app',
6
+ template: `
7
+ <p-heading tag="h3">
8
+ The quick brown fox jumps over the lazy dog
9
+ </p-heading>
10
+
11
+ <p-heading>
12
+ <h3>
13
+ The quick brown fox jumps over the lazy dog
14
+ </h3>
15
+ </p-heading>
16
+ `,
17
+ changeDetection: ChangeDetectionStrategy.OnPush,
18
+ standalone: true,
19
+ imports: [PorscheDesignSystemModule], // <-- PDS module is imported here
20
+ })
21
+ export class ExampleComponent {}