@ukic/web-components 2.1.0-beta.1 → 2.1.0-beta.2

package/dist/types/components/ic-classification-banner/ic-classification-banner.d.ts

@@ -1,23 +1,23 @@
 import { IcProtectiveMarkings } from "./ic-classification-banner.types";
 export declare class ClassificationBanner {
   /**
-   * Additional information to display after the classification
+   * The additional information that will be displayed after the classification.
    */
   additionalSelectors?: string;
   /**
-   * The classification level to be displayed also determines the banner and text colour
+   * The classification level to be displayed - also determines the banner and text colour.
    */
   classification?: IcProtectiveMarkings;
   /**
-   * Optional text displayed before classification to specify relevant country/countries
+   * The optional text that will be displayed before classification to specify relevant country/countries.
    */
   country?: string;
   /**
-   * Determines whether the banner appears inline with the page or sticks to the bottom of the page
+   * If `true`, the banner will appear inline with the page, instead of sticking to the bottom of the page.
    */
   inline?: boolean;
   /**
-   * Optionally display "Up to" before classification and country if set
+   * If `true`, "Up to" will be displayed before the classification and country.
    */
   upTo?: boolean;
   render(): any;

package/dist/types/components/ic-data-entity/ic-data-entity.d.ts

@@ -1,11 +1,11 @@
 export declare class DataEntity {
   el: HTMLIcDataEntityElement;
   /**
-   * Title for the data entity
+   * The title for the data entity.
    */
   heading: string;
   /**
-   * Set the data heading and all child data rows to small styling
+   * If `true`, the small styling will be applied to the data heading and all child data rows.
    */
   small: boolean;
   render(): any;

package/dist/types/components/ic-data-row/ic-data-row.d.ts

@@ -6,15 +6,15 @@
 export declare class DataRow {
   el: HTMLIcDataRowElement;
   /**
-   * Set the label in the leftmost cell of the row
+   * The label in the leftmost cell of the row.
    */
   label: string;
   /**
-   * Set the value of the middle (right if no addition supplied) cell of the row
+   * The value of the middle (right if no end-component supplied) cell of the row.
    */
   value: string;
   /**
-   * Set the row to small styling, this is automatically applied if small is set on the parent data heading
+   * If `true`, the small styling will be applied to the row. This is automatically applied if small is set on the parent data heading.
    */
   small: boolean;
   deviceSize: number;

package/dist/types/components/ic-footer/ic-footer.d.ts

@@ -2,10 +2,10 @@ import { EventEmitter } from "../../stencil-public-runtime";
 import { IcAlignment, IcThemeForeground } from "../../utils/types";
 import { IcFooterBreakpoints } from "./ic-footer.types";
 /**
- * @slot description - Content will be rendered at the top of the footer
- * @slot link - Content will be rendered between description and logos
- * @slot logo - Content will be rendered underneath footer links
- * @slot caption - Content will be rendered above Crown Copyright
+ * @slot description - Content will be rendered at the top of the footer.
+ * @slot link - Content will be rendered between description and logos.
+ * @slot logo - Content will be rendered underneath footer links.
+ * @slot caption - Content will be rendered above Crown Copyright.
  */
 export declare class Footer {
   el: HTMLIcFooterElement;
@@ -14,27 +14,27 @@ export declare class Footer {
    */
   icFooterResized: EventEmitter<void>;
   /**
-   * The description displayed at the top of the footer
+   * The description displayed at the top of the footer.
    */
   description: string;
   /**
-   * Sets the aligned parameter for the section containers used within the footer
+   * The alignment of the section containers used within the footer.
    */
   aligned?: IcAlignment;
   /**
-   * Sets the screen size breakpoint at which to switch to the small layout
+   * The screen size breakpoint at which to switch to the small layout.
    */
   breakpoint?: IcFooterBreakpoints;
   /**
-   * Sets the footer up to handle link groups instead of standalone links
+   * If `true`, the footer will be set up to handle link groups instead of standalone links.
    */
   groupLinks?: boolean;
   /**
-   * The caption displayed at the bottom of the footer
+   * The caption displayed at the bottom of the footer.
    */
   caption: string;
   /**
-   * Whether the footer displays the crown copyright at the bottom
+   * If `true`, the footer will display the crown copyright at the bottom.
    */
   copyright: boolean;
   deviceSize: number;

package/dist/types/components/ic-footer-link-group/ic-footer-link-group.d.ts

@@ -1,7 +1,7 @@
 export declare class FooterLinkGroup {
   el: HTMLIcFooterLinkGroupElement;
   /**
-   * Sets the title of the link group for display
+   * The title of the link group to be displayed.
    */
   groupTitle: string;
   small: boolean;

package/dist/types/components/ic-hero/ic-hero.d.ts

@@ -9,39 +9,39 @@ import { IcHeroContentAlignments } from "./ic-hero.types";
 export declare class Hero {
   el: HTMLIcHeroElement;
   /**
-   * The heading of the hero
+   * The heading of the hero.
    */
   heading: string;
   /**
-   * Description for the hero
+   * The description for the hero.
    */
   subheading?: string;
   /**
-   * Optional secondary heading, replaced by slotted right content
+   * The optional secondary heading, replaced by slotted right content.
    */
   secondaryHeading?: string;
   /**
-   * Optional secondary subheading, replaced by slotted right content
+   * The optional secondary subheading, replaced by slotted right content.
    */
   secondarySubheading?: string;
   /**
-   * Optional background image
+   * The optional background image.
    */
   backgroundImage?: string;
   /**
-   * Whether the background image (if set) scrolls using a parallax effect.
+   * If `true`, the background image (if set) will not scroll using a parallax effect.
    */
   disableBackgroundParallax?: boolean;
   /**
-   * The alignment of the hero content
+   * The alignment of the hero.
    */
   aligned: IcAlignment;
   /**
-   * The alignment of the hero content
+   * The alignment of the hero content.
    */
   contentAligned: IcHeroContentAlignments;
   /**
-   * Alter styling for use with small content/pages
+   * If `true`, the small styling will be applied to the hero.
    */
   small: boolean;
   rightContent: boolean;

package/dist/types/components/ic-input-component-container/ic-input-component-container.d.ts

@@ -4,35 +4,35 @@ import { IcInformationStatusOrEmpty } from "../../utils/types";
  */
 export declare class InputComponentContainer {
   /**
-   * disabled
+   *  If `true`, the disabled state will be set.
    */
   disabled: boolean;
   /**
-   * readonly
+   *  If `true`, the readonly state will be set.
    */
   readonly: boolean;
   /**
-   * validationStatus
+   * The validation status of the input component container - e.g. 'error' | 'warning' | 'success'.
    */
   validationStatus: IcInformationStatusOrEmpty;
   /**
-   * small
+   *  If `true`, the small styling will be applied to the input component container.
    */
   small: boolean;
   /**
-   * multiLine
+   *  If `true`, the input component container will allow for multiple lines.
    */
   multiLine: boolean;
   /**
-   * validationInline
+   *  If `true`, the validation will display inline.
    */
   validationInline: boolean;
   /**
-   * Determines whether the dark variant of the input-component-container focus indicator should be displayed.
+   *  If `true`, the dark variant of the input component container will be displayed.
    */
   dark?: boolean;
   /**
-   *  If true then fill width of container
+   *  If `true`, the input component container will fill the width of the container it is in.
    */
   fullWidth: boolean;
   host: HTMLIcInputComponentContainerElement;

package/dist/types/components/ic-input-container/ic-input-container.d.ts

@@ -1,10 +1,10 @@
 export declare class InputContainer {
   /**
-   * disabled
+   * If `true`, the disabled state will be set.
    */
   disabled?: boolean;
   /**
-   * readonly
+   * If `true`, the readonly state will be set.
    */
   readonly?: boolean;
   render(): any;

package/dist/types/components/ic-input-label/ic-input-label.d.ts

@@ -1,34 +1,34 @@
 export declare class InputLabel {
   /**
-   * for
+   * The ID of the form element the label is bound to.
    */
   for: string;
   /**
-   * required
+   * If `true`, the input label will require a value.
    */
   required: boolean;
   /**
-   * helperText
+   * The helper text that will be displayed.
    */
   helperText: string;
   /**
-   * label
+   * The text content of the label.
    */
   label: string;
   /**
-   * disabled
+   * If `true`, the disabled state will be set.
    */
   disabled: boolean;
   /**
-   * readonly
+   * If `true`, the readonly state will be set.
    */
   readonly: boolean;
   /**
-   * error
+   * If `true`, the input label will display with error styling.
    */
   error?: boolean;
   /**
-   * dark
+   * If `true`, the dark variant of the input label will be displayed.
    */
   dark?: boolean;
   componentDidLoad(): void;

package/dist/types/components/ic-input-validation/ic-input-validation.d.ts

@@ -6,23 +6,23 @@ import { IcAriaLiveModeVariants } from "./ic-input-validation.types";
 export declare class InputValidation {
   el: HTMLIcInputValidationElement;
   /**
-   * The validation message to display
+   * The validation message to display.
    */
   message: string;
   /**
-   * The id of the input field the message relates to
+   * The ID of the form element the validation is bound to.
    */
   for: string;
   /**
-   * The status
+   * The status of the validation - e.g. 'error' | 'warning' | 'success'.
    */
   status: IcInformationStatusOrEmpty;
   /**
-   *  If true then fill width of container
+   *  If `true`, the input validation will fill the width of the container.
    */
   fullWidth: boolean;
   /**
-   *  aria live mode to apply to message
+   *  The ARIA live mode to apply to the message.
    */
   ariaLiveMode: IcAriaLiveModeVariants;
   componentDidLoad(): void;

package/dist/types/components/ic-link/ic-link.d.ts

@@ -1,13 +1,13 @@
 import { IcThemeForeground } from "../../utils/types";
 /**
- * @slot router-item - Handle routing by nesting your routes in this slot
+ * @slot router-item - Handle routing by nesting your routes in this slot.
  */
 export declare class Link {
   private inheritedAttributes;
   private routerSlot;
   el: HTMLIcLinkElement;
   /**
-   * Prompts the user to save the linked URL instead of navigating to it.
+   * If `true`, the user can save the linked URL instead of navigating to it.
    */
   download?: string | boolean;
   /**
@@ -15,7 +15,7 @@ export declare class Link {
    */
   href?: string;
   /**
-   * Hints at the human language of the linked URL.
+   * The human language of the linked URL.
    */
   hreflang?: string;
   /**
@@ -27,15 +27,15 @@ export declare class Link {
    */
   rel?: string;
   /**
-   * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
+   * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
    */
   target?: string;
   /**
-   * Determines whether the 'open in new tab/window' icon is to be displayed.
+   * If `true`, the 'open in new tab/window' icon will be displayed.
    */
   showIcon?: boolean;
   /**
-   * Determines the whether the appearance is dark, light, or the default.
+   * The appearance of the link, e.g. dark, light, or default.
    */
   appearance?: IcThemeForeground;
   themeChangeHandler(ev: CustomEvent): void;

package/dist/types/components/ic-loading-indicator/ic-loading-indicator.d.ts

@@ -23,7 +23,7 @@ export declare class LoadingIndicator {
    */
   label?: string;
   /**
-   * Provide a description to be set as the aria-label of the loading indicator when not using a visible label.
+   * The description that will be set as the aria-label of the loading indicator when not using a visible label.
    */
   description?: string;
   /**
@@ -39,11 +39,11 @@ export declare class LoadingIndicator {
    */
   type?: IcLoadingTypes;
   /**
-   * When linear, determines whether the full-width version (i.e. without a border radius) should be displayed.
+   * If `true`, when linear, the full-width variant (i.e. without a border radius) will be displayed.
    */
   fullWidth?: boolean;
   /**
-   * Determines whether the dark or light loading indicator should be displayed.
+   * The appearance of the loading indicator, e.g. dark or light.
    */
   appearance?: IcThemeForegroundNoDefault;
   indicatorLabel: string;

package/dist/types/components/ic-menu/ic-menu.d.ts

@@ -4,19 +4,19 @@ import { IcOptionSelectEventDetail, IcMenuChangeEventDetail, IcMenuOptionIdEvent
 export declare class Menu {
   host: HTMLIcMenuElement;
   /**
-   * Specify whether the menu is open.
+   * If `true`, the menu will be displayed open.
    */
   open: boolean;
   /**
-   * Provide the possible selection options.
+   * The possible menu selection options.
    */
   options: IcMenuOption[];
   /**
-   * Specify whether small styling is to be applied to the element.
+   * If `true`, the small styling will be applied to the menu.
    */
   small?: boolean;
   /**
-   * Id of the menu.
+   * The ID of the menu.
    */
   menuId: string;
   /**
@@ -28,27 +28,27 @@ export declare class Menu {
    */
   activationType?: IcActivationTypes;
   /**
-   * Reference to the input element.
+   * The reference to the input element.
    */
   inputEl: HTMLElement;
   /**
-   * @internal - set if ic-menu is nested inside another component
+   * @internal - The parent element if ic-menu is nested inside another component.
    */
   parentEl?: HTMLElement;
   /**
-   * Label for the input element.
+   * The label for the input element.
    */
   inputLabel: string;
   /**
-   * Reference to an anchor element the menu will position itself from when rendered.
+   * The reference to an anchor element the menu will position itself from when rendered.
    */
   anchorEl: HTMLElement;
   /**
-   *  If true then fill width of container
+   *  If `true`, the menu will fill the width of the container.
    */
   fullWidth: boolean;
   /**
-   * @internal If true, autofocus on selected item when menu is open
+   * @internal If `true`, autofocus will be applied on selected item when menu is open.
    */
   autoFocusOnSelected: boolean;
   keyboardNav: boolean;

package/dist/types/components/ic-navigation-button/ic-navigation-button.d.ts

@@ -6,7 +6,7 @@ import { IcNavButtonModes } from "./ic-navigation-button.types";
 export declare class NavigationButton {
   el: HTMLIcNavigationButtonElement;
   /**
-   *  label info to display
+   * The label info to display.
    */
   label: string;
   /**
@@ -14,7 +14,7 @@ export declare class NavigationButton {
    */
   href?: string;
   /**
-   * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
+   * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
    */
   target?: string;
   /**
@@ -22,11 +22,11 @@ export declare class NavigationButton {
    */
   rel?: string;
   /**
-   * Prompts the user to save the linked URL instead of navigating to it.
+   * If `true`, the user can save the linked URL instead of navigating to it.
    */
   download?: string | boolean;
   /**
-   * Hints at the human language of the linked URL.
+   * The human language of the linked URL.
    */
   hreflang?: string;
   /**
@@ -34,7 +34,7 @@ export declare class NavigationButton {
    */
   referrerpolicy?: ReferrerPolicy;
   /**
-   *  display mode
+   * The display mode.
    */
   mode: IcNavButtonModes;
   initialAppearance: IcThemeForeground;

package/dist/types/components/ic-navigation-group/ic-navigation-group.d.ts

@@ -2,11 +2,11 @@ import { IcNavType } from "../../utils/types";
 export declare class NavigationGroup {
   el: HTMLIcNavigationGroupElement;
   /**
-   *  label to display on the group
+   * The label to display on the group.
    */
   label: string;
   /**
-   *  whether the group should be expandable/collapsible in the side menu
+   *  If `true`, the group will be expandable in the side menu.
    */
   expandable: boolean;
   dropdownOpen: boolean;

package/dist/types/components/ic-navigation-item/ic-navigation-item.d.ts

@@ -6,27 +6,27 @@ import { IcNavType } from "../../utils/types";
 export declare class NavigationItem {
   el: HTMLIcNavigationItemElement;
   /**
-   *  Label of the navigation item
+   * The label of the navigation item.
    */
   label: string;
   /**
-   *  Destination of the navigation item
+   * The destination of the navigation item.
    */
   href: string;
   /**
-   *  If true, sets the navigation item in a selected state
+   *  If `true`, the navigation item will be set in a selected state.
    */
   selected: boolean;
   /**
-   *  @internal Whether the navigation item is expandable
+   *  @internal If `true`, the navigation item will be expandable.
    */
   expandable: boolean;
   /**
-   * @internal display navigation item within tooltip
+   * @internal If `true`, the navigation item will be displayed within a tooltip.
    */
   displayNavigationTooltip: boolean;
   /**
-   * @internal display icon and label when side navigation is collapsed
+   * @internal If `true`, the icon and label will be displayed when side navigation is collapsed.
    */
   collapsedIconLabel: boolean;
   isTopNavChild: boolean;

package/dist/types/components/ic-navigation-menu/ic-navigation-menu.d.ts

@@ -6,11 +6,11 @@ import { EventEmitter } from "../../stencil-public-runtime";
 export declare class NavigationMenu {
   el: HTMLIcNavigationMenuElement;
   /**
-   *  Version info to display
+   * The version info to display.
    */
   version: string;
   /**
-   *  Status info to display
+   * The status info to display.
    */
   status: string;
   /**

package/dist/types/components/ic-page-header/ic-page-header.d.ts

@@ -12,33 +12,35 @@ import { IcAlignment } from "../../utils/types";
 export declare class PageHeader {
   el: HTMLIcPageHeaderElement;
   /**
-   * The title to render on the component.
+   * The title to render on the page header.
    */
   heading?: string;
   /**
-   * The subtitle to render on the component.
+   * The subtitle to render on the page header.
    */
   subheading?: string;
   /**
-   * How the component should be aligned.
+   * The alignment of the page header.
    */
   aligned?: IcAlignment;
   /**
-   * Whether the component uses small styling.
+   * If `true`, the small styling will be applied to the page header.
    */
   small?: boolean;
   /**
-   * Set whether the bottom border is used
+   * If `true`, a border will be displayed along the bottom of the page header.
    */
   border?: boolean;
   /**
-   * Set whether the header is sticky at all breakpoints
+   * If `true`, the page header will be sticky at all breakpoints.
    */
   sticky?: boolean;
-  /** Set whether the header is only sticky for viewport widths of 992px and above
+  /**
+   *  If `true`, the page header will only be sticky for viewport widths of 992px and above.
    */
   stickyDesktopOnly?: boolean;
-  /** Set whether the reading pattern and tab order change in the action area for viewport widths of above 576px and when actions have not wrapped
+  /**
+   * If `true`, the reading pattern and tab order will change in the action area for viewport widths of above 576px and when actions have not wrapped.
    */
   reverseOrder?: boolean;
   deviceSize: number;

package/dist/types/components/ic-radio-group/ic-radio-group.d.ts

@@ -5,43 +5,43 @@ export declare class RadioGroup {
   private radioOptions;
   host: HTMLIcRadioGroupElement;
   /**
-   * Provide a label for the input.
+   * The label for the radio group to be displayed.
    */
   label: string;
   /**
-   * Provide a name for the input.
+   * The name for the radio group to differentiate from other groups.
    */
   name: string;
   /**
-   * Specify if the input requires a value.
+   * If `true`, the radio group will require a value.
    */
   required: boolean;
   /**
-   * Hides the label and applies the required label value as an aria-label.
+   * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
    */
   hideLabel: boolean;
   /**
-   * Specify whether the input is disabled.
+   * If `true`, the disabled state will be set.
    */
   disabled: boolean;
   /**
-   * Provide helper text to display additional field guidance.
+   * The helper text that will be displayed for additional field guidance.
    */
   helperText: string;
   /**
-   * Specify whether small styling is to be applied to the element.
+   * If `true`, the small styling will be applied to the radio group.
    */
   small: boolean;
   /**
-   * Provide validation status - 'error'
+   * The validation status - e.g. 'error' | 'warning' | 'success'.
    */
   validationStatus: IcInformationStatusOrEmpty;
   /**
-   * Provide validation text - 'error'
+   * The validation text - e.g. 'error' | 'warning' | 'success'.
    */
   validationText: string;
   /**
-   * Provide checked state
+   * The checked state.
    */
   checkedValue: string;
   selectedChild: number;