Skip to content

Commit

Permalink
docs(action-bar, action-group, action-pad, alert): consistent api dec…
Browse files Browse the repository at this point in the history
…ription refs (#8533)

**Related Issue:** #7071

## Summary
Updates doc consistency across a-named components defined in the above
issue for props, events, methods, and css vars, including:
- `action-bar`
- `action-group`
- `action-pad`
- `alert`

cc @DitwanP
  • Loading branch information
geospatialem authored and benelan committed Jan 2, 2024
1 parent a4621be commit 4de7076
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*
* These properties can be overridden using the component's tag as selector.
*
* @prop --calcite-action-bar-expanded-max-width: optionally specify the expanded max width of the action bar when in "vertical" layout.
* @prop --calcite-action-bar-expanded-max-width: When `layout` is `"vertical"`, specifies the expanded max width of the component.
*/

:host {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export class ActionBar
// --------------------------------------------------------------------------

/**
* Specifies the accessible label for the last action-group.
* Specifies the accessible label for the last `calcite-action-group`.
*/
@Prop() actionsEndGroupLabel: string;

Expand All @@ -98,7 +98,7 @@ export class ActionBar
}

/**
* The layout direction of the actions.
* Specifies the layout direction of the actions.
*/
@Prop({ reflect: true }) layout: Extract<"horizontal" | "vertical", Layout> = "vertical";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export class ActionGroup
}

/**
* Specifies the label of the component. Required for accessibility.
* Accessible name for the component.
*/
@Prop() label: string;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*
* These properties can be overridden using the component's tag as selector.
*
* @prop --calcite-action-pad-expanded-max-width: optionally specify the expanded max width of the action pad when in "vertical" layout.
* @prop --calcite-action-pad-expanded-max-width: When `layout` is `"vertical"`, specifies the expanded max width of the component.
*/

:host {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export class ActionPad
// --------------------------------------------------------------------------

/**
* Specifies the accessible label for the last action-group.
* Specifies the accessible label for the last `calcite-action-group`.
*/
@Prop() actionsEndGroupLabel: string;

Expand Down
10 changes: 5 additions & 5 deletions packages/calcite-components/src/components/alert/alert.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,13 @@ export class Alert implements OpenCloseComponent, LoadableComponent, T9nComponen
}
}

/** When `true`, the component closes automatically (recommended for passive, non-blocking alerts). */
/** When `true`, the component closes automatically. Recommended for passive, non-blocking alerts. */
@Prop({ reflect: true }) autoClose = false;

/** Specifies the duration before the component automatically closes (only use with `autoClose`). */
/** Specifies the duration before the component automatically closes - only use with `autoClose`. */
@Prop({ reflect: true }) autoCloseDuration: AlertDuration = "medium";

/** Specifies the kind of the component (will apply to top border and icon). */
/** Specifies the kind of the component, which will apply to top border and icon. */
@Prop({ reflect: true }) kind: Extract<
"brand" | "danger" | "info" | "success" | "warning",
Kind
Expand All @@ -116,7 +116,7 @@ export class Alert implements OpenCloseComponent, LoadableComponent, T9nComponen
*/
@Prop({ reflect: true }) numberingSystem: NumberingSystem;

/** Specifies the placement of the component */
/** Specifies the placement of the component. */
@Prop({ reflect: true }) placement: MenuPlacement = "bottom";

/** Specifies the size of the component. */
Expand Down Expand Up @@ -371,7 +371,7 @@ export class Alert implements OpenCloseComponent, LoadableComponent, T9nComponen
//
//--------------------------------------------------------------------------

/** Sets focus on the component's "close" button (the first focusable item). */
/** Sets focus on the component's "close" button, the first focusable item. */
@Method()
async setFocus(): Promise<void> {
await componentFocusable(this);
Expand Down

0 comments on commit 4de7076

Please sign in to comment.