From 8a6579b36d89589197bb839a1589c2384f1210f4 Mon Sep 17 00:00:00 2001 From: ilhan007 Date: Tue, 22 Apr 2025 10:58:02 +0300 Subject: [PATCH 1/3] feat(ui5-form, ui5-form-group): add `headerLevel` prop --- packages/main/src/Form.ts | 11 +++++++++++ packages/main/src/FormGroup.ts | 10 ++++++++++ packages/main/src/FormTemplate.tsx | 4 ++-- 3 files changed, 23 insertions(+), 2 deletions(-) diff --git a/packages/main/src/Form.ts b/packages/main/src/Form.ts index c4e91e5a50e1..6b8263ec3891 100644 --- a/packages/main/src/Form.ts +++ b/packages/main/src/Form.ts @@ -12,6 +12,7 @@ import FormCss from "./generated/themes/Form.css.js"; import type FormItemSpacing from "./types/FormItemSpacing.js"; import type FormGroup from "./FormGroup.js"; +import type TitleLevel from "./types/TitleLevel.js"; const additionalStylesMap = new Map(); @@ -41,6 +42,7 @@ interface IFormItem extends UI5Element { colsS?: number; columnSpan?: number; headerText?: string; + headerLevel?: `${TitleLevel}`; } type GroupItemsInfo = { @@ -265,6 +267,15 @@ class Form extends UI5Element { @property() headerText?: string; + /** + * Defines the "aria-level" of component heading, + * set by the `headerText`. + * @default "H2" + * @public + */ + @property() + headerLevel: `${TitleLevel}` = "H4"; + /** * Defines the vertical spacing between form items. * diff --git a/packages/main/src/FormGroup.ts b/packages/main/src/FormGroup.ts index e857ca9ea74c..b434ad417f7a 100644 --- a/packages/main/src/FormGroup.ts +++ b/packages/main/src/FormGroup.ts @@ -6,6 +6,7 @@ import slot from "@ui5/webcomponents-base/dist/decorators/slot.js"; import type FormItem from "./FormItem.js"; import type { IFormItem } from "./Form.js"; import type FormItemSpacing from "./types/FormItemSpacing.js"; +import type TitleLevel from "./types/TitleLevel.js"; /** * @class @@ -47,6 +48,15 @@ class FormGroup extends UI5Element implements IFormItem { @property() headerText?: string; + /** + * Defines the "aria-level" of component heading, + * set by the `headerText`. + * @default "H6" + * @public + */ + @property() + headerLevel: `${TitleLevel}` = "H5"; + /** * Defines column span of the component, * e.g how many columns the group should span to. diff --git a/packages/main/src/FormTemplate.tsx b/packages/main/src/FormTemplate.tsx index 9858bba16d3c..cc5b59501367 100644 --- a/packages/main/src/FormTemplate.tsx +++ b/packages/main/src/FormTemplate.tsx @@ -13,7 +13,7 @@ export default function FormTemplate(this: Form) { {this.hasCustomHeader ? : - {this.headerText} + {this.headerText} } } @@ -38,7 +38,7 @@ export default function FormTemplate(this: Form) {
{groupItem.headerText &&
- {groupItem.headerText} + {groupItem.headerText}
} From e55f6658b76380a742f21e8c69404b72ce2e5912 Mon Sep 17 00:00:00 2001 From: ilhan007 Date: Tue, 22 Apr 2025 11:13:50 +0300 Subject: [PATCH 2/3] chore: update jsdoc --- packages/main/src/Form.ts | 2 +- packages/main/src/FormGroup.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/main/src/Form.ts b/packages/main/src/Form.ts index 6b8263ec3891..12c7262019bf 100644 --- a/packages/main/src/Form.ts +++ b/packages/main/src/Form.ts @@ -268,7 +268,7 @@ class Form extends UI5Element { headerText?: string; /** - * Defines the "aria-level" of component heading, + * Defines the compoennt heading level, * set by the `headerText`. * @default "H2" * @public diff --git a/packages/main/src/FormGroup.ts b/packages/main/src/FormGroup.ts index b434ad417f7a..2cf0b2f1b139 100644 --- a/packages/main/src/FormGroup.ts +++ b/packages/main/src/FormGroup.ts @@ -49,7 +49,7 @@ class FormGroup extends UI5Element implements IFormItem { headerText?: string; /** - * Defines the "aria-level" of component heading, + * Defines the compoennt heading level, * set by the `headerText`. * @default "H6" * @public From cf25ce3c20127fe197f190c93eb6c1f5becffab8 Mon Sep 17 00:00:00 2001 From: ilhan007 Date: Thu, 24 Apr 2025 15:48:51 +0300 Subject: [PATCH 3/3] docs: fix since and default tags --- packages/main/src/Form.ts | 3 ++- packages/main/src/FormGroup.ts | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/main/src/Form.ts b/packages/main/src/Form.ts index 12c7262019bf..66305f935a50 100644 --- a/packages/main/src/Form.ts +++ b/packages/main/src/Form.ts @@ -270,7 +270,8 @@ class Form extends UI5Element { /** * Defines the compoennt heading level, * set by the `headerText`. - * @default "H2" + * @default "H4" + * @since 2.10.0 * @public */ @property() diff --git a/packages/main/src/FormGroup.ts b/packages/main/src/FormGroup.ts index 2cf0b2f1b139..b958f1e6bcb2 100644 --- a/packages/main/src/FormGroup.ts +++ b/packages/main/src/FormGroup.ts @@ -51,8 +51,9 @@ class FormGroup extends UI5Element implements IFormItem { /** * Defines the compoennt heading level, * set by the `headerText`. - * @default "H6" + * @default "H5" * @public + * @since 2.10.0 */ @property() headerLevel: `${TitleLevel}` = "H5";