@genspectrum/dashboard-components 0.6.0 → 0.6.2

package/dist/genspectrum-components.d.ts

@@ -180,6 +180,53 @@ export declare class DateRangeSelectorComponent extends PreactLitAdapter {
 
 declare type LapisFilter = Record<string, string | number | null | boolean>;
 
+/**
+ *
+ * ## Context
+ *
+ * This component provides a text input field to filter by lineages.
+ * Currently, it is designed to work well with Pango Lineages,
+ * but it may also be used for other lineage types, if suitable.
+ *
+ * It fetches all available values of the `lapisField` from the LAPIS instance
+ * and provides an autocomplete list with the available values of the lineage and sublineage queries
+ * (a `*` appended to the lineage value).
+ *
+ * @fires {CustomEvent<Record<string, string>>} gs-lineage-filter-changed
+ * Fired when the input field is changed.
+ * The `details` of this event contain an object with the `lapisField` as key and the input value as value.
+ * Example:
+ * ```
+ * {
+ *  "pangoLineage": "B.1.1.7"
+ * }
+ *  ```
+ */
+export declare class LineageFilterComponent extends PreactLitAdapter {
+    /**
+     * The initial value to use for this lineage filter.
+     */
+    initialValue: string;
+    /**
+     * Required.
+     *
+     * The LAPIS field name to use for this lineage filter.
+     * The field must exist on this LAPIS instance.
+     */
+    lapisField: string;
+    /**
+     * The placeholder text to display in the input field.
+     */
+    placeholderText: string;
+    /**
+     * The width of the component.
+     *
+     * Visit https://genspectrum.github.io/dashboard-components/?path=/docs/components-size-of-components--docs for more information.
+     */
+    width: string;
+    render(): JSX_2.Element;
+}
+
 /**
  * ## Context
  *
@@ -929,6 +976,16 @@ declare global {
 }
 
 
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-lineage-filter': LineageFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        'gs-lineage-filter-changed': CustomEvent<Record<string, string>>;
+    }
+}
+
+
 declare module 'chart.js' {
     interface CartesianScaleTypeRegistry {
         logit: {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@genspectrum/dashboard-components",
-    "version": "0.6.0",
+    "version": "0.6.2",
     "description": "GenSpectrum web components for building dashboards",
     "type": "module",
     "license": "AGPL-3.0-only",