Unify JSDoc property descriptions (#7273)

packages/components/src/components/accordion/shadow.tsx

@@ -123,7 +123,7 @@ export class KolAccordion implements AccordionAPI, FocusableElement {
 	@Prop() public _on?: AccordionCallbacksPropType<boolean>;
 
 	/**
-	 * If set (to true) opens/expands the element, closes if not set (or set to false).
+	 * Opens/expands the element when truthy, closes/collapses when falsy.
 	 * @TODO: Change type back to `OpenPropType` after Stencil#4663 has been resolved.
 	 */
 	@Prop({ mutable: true, reflect: true }) public _open?: boolean = false;

packages/components/src/components/button-link/shadow.tsx

@@ -87,7 +87,7 @@ export class KolButtonLink implements ButtonLinkProps, FocusableElement {
 	}
 
 	/**
-	 * Defines the elements access key.
+	 * Defines which key combination can be used to trigger or focus the interactive element of the component.
 	 */
 	@Prop() public _accessKey?: AccessKeyPropType;
 

packages/components/src/components/button/component.tsx

@@ -168,7 +168,7 @@ export class KolButtonWc implements ButtonAPI, FocusableElement {
 	private readonly controller: AssociatedInputController;
 
 	/**
-	 * Defines the elements access key.
+	 * Defines which key combination can be used to trigger or focus the interactive element of the component.
 	 */
 	@Prop() public _accessKey?: AccessKeyPropType;
 

packages/components/src/components/button/shadow.tsx

@@ -94,7 +94,7 @@ export class KolButton implements ButtonProps, FocusableElement {
 	}
 
 	/**
-	 * Defines the elements access key.
+	 * Defines which key combination can be used to trigger or focus the interactive element of the component.
 	 */
 	@Prop() public _accessKey?: AccessKeyPropType;
 
@@ -166,7 +166,7 @@ export class KolButton implements ButtonProps, FocusableElement {
 	@Prop() public _role?: AlternativeButtonLinkRolePropType;
 
 	/**
-	 * Defines the elements short key.
+	 * Adds a visual short key hint to the component.
 	 */
 	@Prop() public _shortKey?: ShortKeyPropType;
 

packages/components/src/components/combobox/shadow.tsx

@@ -436,7 +436,7 @@ export class KolCombobox implements ComboboxAPI {
 	@Prop() public _on?: InputTypeOnDefault;
 
 	/**
-	 * Suggestions the user can choose from.
+	 * Suggestions to provide for the input.
 	 */
 	@Prop() public _suggestions!: SuggestionsPropType;
 

packages/components/src/components/details/shadow.tsx

@@ -118,7 +118,7 @@ export class KolDetails implements DetailsAPI, FocusableElement {
 	@Prop() public _on?: DetailsCallbacksPropType<boolean>;
 
 	/**
-	 * If set (to true) opens/expands the element, closes if not set (or set to false).
+	 * Opens/expands the element when truthy, closes/collapses when falsy.
 	 * @TODO: Change type back to `OpenPropType` after Stencil#4663 has been resolved.
 	 */
 	@Prop({ mutable: true, reflect: true }) public _open?: boolean = false;

packages/components/src/components/drawer/shadow.tsx

@@ -73,12 +73,12 @@ export class KolDrawer implements DrawerAPI {
 	}
 
 	/**
-	 * Specifies the default open state of the drawer.
+	 * Opens/expands the element when truthy, closes/collapses when falsy.
 	 */
 	@Prop() public _open?: OpenPropType;
 
 	/**
-	 * Specifies the orientation of the drawer.
+	 * Defines the visual orientation of the component.
 	 */
 	@Prop() public _align?: AlignPropType;
 

packages/components/src/components/input/component.tsx

@@ -161,7 +161,7 @@ export class KolInputWc implements Props {
 	}
 
 	/**
-	 * Defines the elements access key.
+	 * Defines which key combination can be used to trigger or focus the interactive element of the component.
 	 */
 	@Prop() public _accessKey?: AccessKeyPropType;
 

packages/components/src/components/link-button/shadow.tsx

@@ -82,7 +82,7 @@ export class KolLinkButton implements LinkButtonProps, FocusableElement {
 	}
 
 	/**
-	 * Defines the elements access key.
+	 * Defines which key combination can be used to trigger or focus the interactive element of the component.
 	 */
 	@Prop() public _accessKey?: AccessKeyPropType;
 

packages/components/src/components/link/component.tsx

@@ -192,7 +192,7 @@ export class KolLinkWc implements LinkAPI, FocusableElement {
 	}
 
 	/**
-	 * Defines the elements access key.
+	 * Defines which key combination can be used to trigger or focus the interactive element of the component.
 	 */
 	@Prop() public _accessKey?: AccessKeyPropType;
 

packages/components/src/components/link/shadow.tsx

@@ -80,7 +80,7 @@ export class KolLink implements LinkProps, FocusableElement {
 	}
 
 	/**
-	 * Defines the elements access key.
+	 * Defines which key combination can be used to trigger or focus the interactive element of the component.
 	 */
 	@Prop() public _accessKey?: AccessKeyPropType;
 
@@ -137,7 +137,7 @@ export class KolLink implements LinkProps, FocusableElement {
 	@Prop() public _role?: AlternativeButtonLinkRolePropType;
 
 	/**
-	 * Defines the elements access key.
+	 * Adds a visual short key hint to the component.
 	 */
 	@Prop() public _shortKey?: ShortKeyPropType;
 

packages/components/src/components/tabs/shadow.tsx

@@ -222,7 +222,7 @@ export class KolTabs implements TabsAPI {
 	}
 
 	/**
-	 * Defines the position of the tab captions.
+	 * Defines the visual orientation of the component.
 	 */
 	@Prop() public _align?: AlignPropType = 'top';
 

packages/components/src/components/toolbar/shadow.tsx

@@ -55,7 +55,7 @@ export class KolToolbar implements ToolbarAPI {
 	}
 
 	/**
-	 * Defines the semantic aria-label of the component.
+	 * Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).
 	 */
 	@Prop() public _label!: string;
 

packages/components/src/components/tree-item/component.tsx

@@ -76,17 +76,17 @@ export class KolTreeItemWc implements TreeItemAPI {
 	@Prop() _active?: OpenPropType;
 
 	/**
-	 * Defines the label of the link.
+	 * Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).
 	 */
 	@Prop() _label!: LabelPropType;
 
 	/**
-	 * If set (to true) opens/expands the element, closes if not set (or set to false).
+	 * Opens/expands the element when truthy, closes/collapses when falsy.
 	 */
 	@Prop() _open?: OpenPropType;
 
 	/**
-	 * This property is used for a link from a reference to the target URL.
+	 * Defines the target URI of the link.
 	 */
 	@Prop() _href!: HrefPropType;
 

packages/components/src/components/tree-item/shadow.tsx

@@ -19,17 +19,17 @@ export class KolTreeItem implements TreeItemProps {
 	@Prop() _active?: OpenPropType;
 
 	/**
-	 * Defines the label of the link.
+	 * Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).
 	 */
 	@Prop() _label!: LabelPropType;
 
 	/**
-	 * If set (to true) opens/expands the element, closes if not set (or set to false).
+	 * Opens/expands the element when truthy, closes/collapses when falsy.
 	 */
 	@Prop() _open?: OpenPropType;
 
 	/**
-	 * This property is used for a link from a reference to the target URL.
+	 * Defines the target URI of the link.
 	 */
 	@Prop() _href!: HrefPropType;
 

packages/components/src/components/tree/component.tsx

@@ -22,7 +22,7 @@ export class KolTreeWc implements TreeAPI {
 	private treeItemElements?: HTMLKolTreeItemElement[];
 
 	/**
-	 * Defines the label of the tree.
+	 * Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).
 	 */
 	@Prop() _label!: LabelPropType;
 

packages/components/src/components/tree/shadow.tsx

@@ -13,7 +13,7 @@ import { KolTreeWcTag } from '../../core/component-names';
 })
 export class KolTree implements TreeProps {
 	/**
-	 * Defines the label of the tree.
+	 * Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).
 	 */
 	@Prop() _label!: LabelPropType;
 

packages/components/src/schema/props/access-key.ts

@@ -5,7 +5,7 @@ import { watchString } from '../utils';
 export type AccessKeyPropType = string;
 
 /**
- * Defines the elements access key.
+ * Defines which key combination can be used to trigger or focus the interactive element of the component.
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/accesskey
  */
 export type PropAccessKey = {

packages/components/src/schema/props/align.ts

@@ -11,7 +11,7 @@ export const alignPropTypeOptions = [...horizontalAlignOptions, ...verticalAlign
 export type AlignPropType = HorizontalAlign | VerticalAlign;
 
 /**
- * Defines where to show the element preferably: top, right, bottom or left.
+ * Defines the visual orientation of the component: top, right, bottom or left.
  */
 export type PropAlign = {
 	align: AlignPropType;

packages/components/src/schema/props/href.ts

@@ -7,7 +7,7 @@ import { watchString } from '../utils';
 export type HrefPropType = string;
 
 /**
- * This property is used for a link from a reference to the target URL.
+ * Defines the target URI of the link.
  */
 export type PropHref = {
 	href: HrefPropType;

packages/components/src/schema/props/label.ts

@@ -51,7 +51,7 @@ export function containsOnlyNumbers(str: string): boolean {
 }
 
 /**
- * Defines the type of the label property.
+ * Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).
  */
 export type LabelPropType = string;
 

packages/components/src/schema/props/open.ts

@@ -7,7 +7,7 @@ import { watchBoolean } from '../utils';
 export type OpenPropType = boolean;
 
 /**
- * If set (to true) opens/expands the element, closes if not set (or set to false).
+ * Opens/expands the element when truthy, closes/collapses when falsy.
  */
 export type PropOpen = {
 	open: OpenPropType;

packages/components/src/schema/props/short-key.ts

@@ -5,7 +5,7 @@ import { watchString } from '../utils';
 export type ShortKeyPropType = string;
 
 /**
- * Defines the elements short key.
+ * Adds a visual short key hint to the component.
  */
 export type PropShortKey = {
 	shortKey: ShortKeyPropType;