Skip to content

Commit 1280ec7

Browse files
docs: fix the description of headingLevel property (#9045)
**Related Issue:** #9044 ## Summary Updating the description of `headingLevel` prop to eliminate confusion on what it's purpose is. --------- Co-authored-by: Kitty Hurley <[email protected]>
1 parent 76b2025 commit 1280ec7

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed

packages/calcite-components/src/components/block/block.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export class Block
9393
@Prop() heading!: string;
9494

9595
/**
96-
* Specifies the number at which section headings should start.
96+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
9797
*/
9898
@Prop({ reflect: true }) headingLevel: HeadingLevel;
9999

packages/calcite-components/src/components/date-picker/date-picker.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export class DatePicker implements LocalizedComponent, LoadableComponent, T9nCom
8282
@Prop({ mutable: true }) value: string | string[];
8383

8484
/**
85-
* Specifies the number at which section headings should start.
85+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
8686
*/
8787
@Prop({ reflect: true }) headingLevel: HeadingLevel;
8888

packages/calcite-components/src/components/flow-item/flow-item.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export class FlowItem
107107
@Prop() heading: string;
108108

109109
/**
110-
* Specifies the number at which section headings should start.
110+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
111111
*/
112112
@Prop({ reflect: true }) headingLevel: HeadingLevel;
113113

packages/calcite-components/src/components/input-date-picker/input-date-picker.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ export class InputDatePicker
203203
}
204204

205205
/**
206-
* Specifies the number at which section headings should start.
206+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
207207
*/
208208
@Prop({ reflect: true }) headingLevel: HeadingLevel;
209209

packages/calcite-components/src/components/panel/panel.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ export class Panel
100100
@Prop({ reflect: true }) collapsible = false;
101101

102102
/**
103-
* Specifies the number at which section headings should start.
103+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
104104
*/
105105
@Prop({ reflect: true }) headingLevel: HeadingLevel;
106106

packages/calcite-components/src/components/pick-list-group/pick-list-group.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export class PickListGroup implements ConditionalSlotComponent {
3131
@Prop({ reflect: true }) groupTitle: string;
3232

3333
/**
34-
* Specifies the number at which section headings should start.
34+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
3535
*/
3636
@Prop({ reflect: true }) headingLevel: HeadingLevel;
3737

packages/calcite-components/src/components/pick-list/pick-list.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export class PickList<
107107
@Prop({ reflect: true, mutable: true }) filterText: string;
108108

109109
/**
110-
* Specifies the number at which section headings should start.
110+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
111111
*/
112112
@Prop({ reflect: true }) headingLevel: HeadingLevel;
113113

packages/calcite-components/src/components/popover/popover.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ export class Popover
138138
@Prop() heading: string;
139139

140140
/**
141-
* Specifies the number at which section headings should start.
141+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
142142
*/
143143
@Prop({ reflect: true }) headingLevel: HeadingLevel;
144144

packages/calcite-components/src/components/tip-manager/tip-manager.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export class TipManager {
4949
}
5050

5151
/**
52-
* Specifies the number at which section headings should start.
52+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
5353
*/
5454
@Prop({ reflect: true }) headingLevel: HeadingLevel;
5555

packages/calcite-components/src/components/tip/tip.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export class Tip implements ConditionalSlotComponent, LocalizedComponent, T9nCom
6060
@Prop() heading: string;
6161

6262
/**
63-
* Specifies the number at which section headings should start.
63+
* Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling.
6464
*/
6565
@Prop({ reflect: true }) headingLevel: HeadingLevel;
6666

0 commit comments

Comments
 (0)