@haiilo/catalyst 0.15.1 → 0.15.2

package/dist/types/components/cat-select-remote/cat-select-remote.d.ts

@@ -13,6 +13,11 @@ export interface RenderInfo {
   label: string;
   description?: string;
 }
+/**
+ * @property resolve - Resolves the value of the select.
+ * @property retrieve - Retrieves the options of the select.
+ * @property render - Renders the selected elements.
+ */
 export interface CatSelectRemoteConnector<T extends Item = any> {
   resolve: (id: string[]) => Observable<T[]>;
   retrieve: (term: string, page: number) => Observable<Page<T>>;
@@ -35,6 +40,15 @@ export interface CatSelectRemoteState {
   activeSelectionIndex: number;
   totalElements?: number;
 }
+/**
+ * Select lets user choose one option from an options' menu. Consider using
+ * select when you have 6 or more options. Select component supports any content
+ * type.
+ *
+ * @slot hint - Optional hint element to be displayed with the select.
+ * @slot label - The slotted label. If both the label property and the label slot are present, only the label slot will be displayed.
+ * @part label - The label content.
+ */
 export declare class CatSelectRemote {
   private static readonly SKELETON_COUNT;
   private static readonly DROPDOWN_OFFSET;
@@ -91,7 +105,7 @@ export declare class CatSelectRemote {
    */
   labelHidden: boolean;
   /**
-   * A value is required or must be check for the form to be submittable.
+   * A value is required or must be checked for the form to be submittable.
    */
   required: boolean;
   /**
@@ -121,6 +135,11 @@ export declare class CatSelectRemote {
   onBlur(event: FocusEvent): void;
   onKeyDown(event: KeyboardEvent): void;
   onKeyUp(event: KeyboardEvent): void;
+  /**
+   * Connect the functions of the select
+   *
+   * @param connector - The {@link CatSelectRemoteConnector} of the select.
+   */
   connect(connector: CatSelectRemoteConnector): Promise<void>;
   render(): any;
   private get hintSection();

package/dist/types/components.d.ts

@@ -481,6 +481,10 @@ export namespace Components {
           * Whether the select should show a clear button.
          */
         "clearable": boolean;
+        /**
+          * Connect the functions of the select
+          * @param connector - The {@link CatSelectRemoteConnector} of the select.
+         */
         "connect": (connector: CatSelectRemoteConnector) => Promise<void>;
         /**
           * The debounce time for the search.
@@ -519,7 +523,7 @@ export namespace Components {
          */
         "placement": Placement;
         /**
-          * A value is required or must be check for the form to be submittable.
+          * A value is required or must be checked for the form to be submittable.
          */
         "required": boolean;
         /**
@@ -1535,7 +1539,7 @@ declare namespace LocalJSX {
          */
         "placement"?: Placement;
         /**
-          * A value is required or must be check for the form to be submittable.
+          * A value is required or must be checked for the form to be submittable.
          */
         "required"?: boolean;
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haiilo/catalyst",
-  "version": "0.15.1",
+  "version": "0.15.2",
   "description": "Catalyst Design System",
   "license": "MIT",
   "repository": {
@@ -43,7 +43,7 @@
   },
   "dependencies": {
     "@floating-ui/dom": "0.4.1",
-    "@haiilo/catalyst-tokens": "0.15.1",
+    "@haiilo/catalyst-tokens": "0.15.2",
     "@stencil/core": "2.17.0",
     "autosize": "5.0.1",
     "autosize-input": "^1.0.2",