@ukho/admiralty-core 0.0.0

package/dist/types/components/select/select.d.ts

@@ -0,0 +1,48 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { UKHOOptions } from './select.types';
+export declare class SelectComponent {
+  el: HTMLElement;
+  id: string;
+  /**
+   * If `true`, the user cannot interact with the select.
+   */
+  disabled: boolean;
+  /**
+   * If 'true', the 'error' class is added to suggest an error
+   */
+  error: boolean;
+  /**
+   * The hint that is used to inform the user of an error (displayed below the select box)
+   */
+  errorHint: string;
+  /**
+   * The text that will be used as a field label.
+   */
+  hint: string;
+  /**
+   * The text that will be used as a field label.
+   */
+  label: string;
+  /**
+   * The maximum width (px) for the input field.
+   */
+  width?: number;
+  /**
+   * Emitted when the value has changed.
+   */
+  admiraltyChange: EventEmitter<EventTarget>;
+  /**
+   * Emitted when the component loses focus.
+   */
+  admiraltyBlur: EventEmitter<void>;
+  componentWillRender(): void;
+  options: Array<UKHOOptions>;
+  handleSelect(event: Event): void;
+  handleBlur(_event: FocusEvent): void;
+  /**
+   *  Summary. gets the options passed the user passes through the slots and
+   *  extracs the text and value
+   */
+  getOptions(): void;
+  render(): any;
+}

package/dist/types/components/select/select.types.d.ts

@@ -0,0 +1,4 @@
+export interface UKHOOptions {
+  text: string;
+  value: string;
+}

package/dist/types/components/side-nav/side-nav.d.ts

@@ -0,0 +1,8 @@
+export declare class SideNavComponent {
+  /**
+   * A label for accessibility purposes to describe what this Side Nav navigation is for
+   * e.g. Product Menu, Map Tool Menu etc.
+   */
+  label: string;
+  render(): any;
+}

package/dist/types/components/side-nav/side-nav.stories.data.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @internal
+ * Wrapper for the Side Nav + Side Nav Items to demonstrate how
+ * the sideNavItemSelected event can be handled and navActive can be set.
+ */
+export declare class SideNavWrapperComponent {
+  el: HTMLElement;
+  onSideNavItemSelected(event: CustomEvent<string>): void;
+  render(): any;
+}

package/dist/types/components/side-nav-item/side-nav-item.d.ts

@@ -0,0 +1,26 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+export declare class SideNavItemComponent {
+  /**
+   * A unique id for this SideNavItem
+   */
+  sideNavItemId: string;
+  /**
+   * The text that is displayed in the SideNavItem
+   */
+  headingTitle: string;
+  /**
+   * Represents whether this SideNavItem is 'active'
+   * and will be styled differently than SideNavItems that are not 'active'.
+   * The intent behind the design for SideNav is for there to only be ONE
+   * SideNavItem that is 'active' per SideNav
+   */
+  navActive: boolean;
+  /**
+   * An event emitted when this Side Nav item is selected containing the sideNavItemId
+   */
+  sideNavItemSelected: EventEmitter<string>;
+  handleClickAction(): void;
+  handleKeyUpAction(ev: KeyboardEvent): void;
+  emitSideNavItemSelected(): void;
+  render(): any;
+}

package/dist/types/components/table/table.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Use tables to make information easier for users to scan and compare
+ * @slot - Table elements should be placed in the slot
+ */
+export declare class Table {
+  caption: string;
+  render(): any;
+}

package/dist/types/components/table-body/table-body.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The table body element is a wrapper for a standard html table body and should be used to wrap rows
+ * @slot - Table rows should be placed in the slot
+ */
+export declare class TableBody {
+  render(): any;
+}

package/dist/types/components/table-cell/table-cell.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The table cell is a wrapper for a standard <td> element and should be used inside of table rows
+ * @slot - The content you wish to display in the table
+ */
+export declare class TableCell {
+  render(): any;
+}

package/dist/types/components/table-header/table-header.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The table header should be used inside a table element to give headers to all the columns
+ * @slot - Table header cells should be placed in the slot
+ */
+export declare class TableHeader {
+  render(): any;
+}

package/dist/types/components/table-header-cell/table-header-cell.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The table header cell element is used for showing headings for the columns
+ * @slot - The content you wish to show as part of the header
+ */
+export declare class TableHeaderCell {
+  render(): any;
+}

package/dist/types/components/table-row/table-row.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The table row element should be used to define rows within the table body
+ * @slot - Table cells should be placed inside the slot
+ */
+export declare class TableRow {
+  render(): any;
+}

package/dist/types/components/textarea/textarea.d.ts

@@ -0,0 +1,45 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+export declare class TextareaComponent {
+  private inputId;
+  /**
+   * The label which will be used as a placeholder in the unfilled state, and as a field label in the filled state.
+   */
+  label: string;
+  /**
+   * The contents of the textarea
+   */
+  text: string;
+  /**
+   * The hint which will be used under the label to describe the input.
+   */
+  hint: string;
+  /**
+   * The maximum width for the input field.
+   */
+  width?: number;
+  /**
+   * This dictates whether the form field is disabled.
+   */
+  disabled: boolean;
+  /**
+   * Whether to show the input in an invalid state
+   */
+  invalid: boolean;
+  /**
+   * The message to show when the input is invalid
+   */
+  invalidMessage: string;
+  /**
+   * Event is fired when the form control loses focus
+   * @event textareaBlur
+   */
+  textareaBlur: EventEmitter<any>;
+  /**
+   * Event is fired when the form control changes
+   * @event textareaChanged
+   */
+  textareaChanged: EventEmitter<string>;
+  private onBlur;
+  private onChange;
+  render(): any;
+}

package/dist/types/components/type-ahead/type-ahead.d.ts

@@ -0,0 +1,66 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+export declare class TypeAheadComponent {
+  private _id;
+  hintId: string;
+  listId: string;
+  el: HTMLElement;
+  listContainer: HTMLDivElement;
+  inputControl: HTMLAdmiraltyInputElement;
+  filterResult: string[];
+  filterList: Array<string>;
+  selectedItemIndex: number;
+  isFocused: boolean;
+  isSilenced: boolean;
+  isAlternateStatusSection: boolean;
+  statusText: string;
+  private originalSearch;
+  private hasBeenFocusedAtLeastOnce;
+  private get inputValue();
+  private set inputValue(value);
+  /**
+   * The value of the textinput
+   */
+  value: string;
+  /**
+   * The text content of the label for the input box
+   */
+  label: string;
+  /**
+   * The placeholder text for the input field
+   */
+  placeholder: string;
+  /**
+   * Optional property to show results when input box is initally focused
+   */
+  resultsOnInitFocus: boolean;
+  /**
+   * Optional function that will be executed when the user selects an item from the typeahead
+   */
+  selectionChanged: EventEmitter<string>;
+  /**
+   * Event that is fired whenever the value of the typeahead changes
+   * e.g. selection from the dropdown or manually typed entry
+   */
+  valueChanged: EventEmitter<string>;
+  connectedCallback(): void;
+  componentDidLoad(): void;
+  handleFocusIn(): void;
+  handleFocusOut(): void;
+  private textChanged;
+  handleKeyPressed(event: KeyboardEvent): void;
+  handleKeyDown(event: KeyboardEvent): void;
+  handleItemSelected(value: string): void;
+  private performFilter;
+  private addHighlight;
+  private removeHighlight;
+  private selectCurrentItem;
+  handleItemHovered(index: number): void;
+  handleComponentFocusOut(): void;
+  /**
+   * Check if the selected option is in view, and scroll if not
+   */
+  private updateScroll;
+  private navigateSuggestions;
+  private getListItemId;
+  render(): any;
+}

package/dist/types/components/type-ahead-item/type-ahead-item.d.ts

@@ -0,0 +1,4 @@
+export declare class AdmiraltyTypeAheadItem {
+  value: string;
+  render(): any;
+}