@esri/calcite-components 1.0.0-next.292 → 1.0.0-next.296

package/dist/types/utils/form.d.ts

@@ -1 +1,112 @@
-export declare const hiddenInputStyle = "\n  bottom: 0 !important;\n  left: 0 !important;\n  margin: 0 !important;\n  opacity: 0 !important;\n  outline: none !important;\n  padding: 0 !important;\n  position: absolute !important;\n  right: 0 !important;\n  top: 0 !important;\n  transform: none !important;\n  -webkit-appearance: none !important;\n  z-index: -1 !important;\n";
+import { FunctionalComponent } from "../stencil-public-runtime";
+/**
+ * Exported for testing purposes.
+ */
+export declare const hiddenFormInputSlotName = "hidden-form-input";
+/**
+ * Defines interface for form-associated components.
+ *
+ * Along with the interface, use the matching form utils to help set up the component behavior.
+ */
+export interface FormComponent<T = any> {
+  /**
+   * When true, this component's value will not be submitted in the form.
+   */
+  disabled: boolean;
+  /**
+   * When true, form submit requests will enforce field requirement.
+   *
+   * @todo remove optional in follow-up PR
+   */
+  required?: boolean;
+  /**
+   * The host element.
+   */
+  readonly el: HTMLElement;
+  /**
+   * The form this component is associated with.
+   */
+  formEl: HTMLFormElement;
+  /**
+   * The name used to submit the value to the associated form.
+   *
+   * Note that this prop should use the @Prop decorator.
+   */
+  name: string;
+  /**
+   * This form component's value.
+   *
+   * Note that this prop should use the @Prop decorator.
+   */
+  value: T;
+  /**
+   * The initial value for this form component.
+   *
+   * When the form is reset, the value will be set to this property.
+   */
+  defaultValue: T;
+  /**
+   * Hook for components to provide custom form reset behavior.
+   */
+  onFormReset?(): void;
+  /**
+   * Hook for components to sync _extra_ props on the hidden input form element used for form-submitting.
+   *
+   * Note: The following props are set by default: disabled, hidden, name, required, value.
+   */
+  syncHiddenFormInput?(input: HTMLInputElement): void;
+}
+/**
+ * Defines interface for checkable form-associated components.
+ *
+ * Along with the interface, use the matching form utils to help set up the component behavior.
+ */
+export interface CheckableFormCompoment<T = any> extends FormComponent<T> {
+  /**
+   * For boolean-valued components, this property defines whether the associated value is submitted to the form or not.
+   */
+  checked: boolean;
+  /**
+   * The initial checked value for this form component.
+   *
+   * When the form is reset, the checked property will be set to this value.
+   *
+   * @todo remove optional in follow-up PR
+   */
+  defaultChecked?: boolean;
+}
+/**
+ * Helper to set up form interactions on connectedCallback.
+ */
+export declare function connectForm<T>(component: FormComponent<T>): void;
+/**
+ * Helper to tear down form interactions on disconnectedCallback.
+ */
+export declare function disconnectForm<T>(component: FormComponent<T>): void;
+/**
+ * Helper for setting the default value on initialization after connectedCallback.
+ *
+ * Note that this is only needed if the default value cannot be determined on connectedCallback.
+ */
+export declare function afterConnectDefaultValueSet<T>(component: FormComponent<T>, value: any): void;
+interface HiddenFormInputSlotProps {
+  component: FormComponent;
+}
+/**
+ * Helper to render the slot for form-associated component's hidden input.
+ *
+ * If the component has a default slot, this must be placed at the bottom of the component's root container to ensure it is the last child.
+ *
+ * render(): VNode {
+ *   <Host>
+ *     <div class={CSS.container}>
+ *     // ...
+ *     <HiddenFormInputSlot component={this} />
+ *     </div>
+ *   </Host>
+ * }
+ *
+ * Note that the hidden-form-input Sass mixin must be added to the component's style to apply specific styles.
+ */
+export declare const HiddenFormInputSlot: FunctionalComponent<HiddenFormInputSlotProps>;
+export {};

package/dist/types/utils/label.d.ts

@@ -16,6 +16,11 @@ export interface LabelableComponent {
    */
   onLabelClick: (event: CustomEvent<any>) => void;
 }
+/**
+ * Exported for testing purposes only
+ * @internal
+ */
+export declare const labelClickEvent = "calciteInternalLabelClick";
 /**
  * Helper to set up label interactions on connectedCallback.
  */

package/dist/types/utils/popper.d.ts

@@ -20,7 +20,7 @@ export declare function updatePopper({ el, modifiers, placement: PopperPlacement
   modifiers: Partial<StrictModifiers>[];
   popper: Popper;
   placement: PopperPlacement;
-}): void;
+}): Promise<void>;
 export declare function hypotenuse(sideA: number, sideB: number): number;
 export declare const defaultOffsetDistance: number;
 export {};