@mosaicajs/components 0.3.0 → 0.4.0

package/dist/filter-panel.d.ts

@@ -6,8 +6,16 @@ import './field-card.js';
 export declare function clusterFieldLayers(meta: Meta, view: string): Layer[];
 /**
  * Use the filter panel as the place where viewers narrow the map down, as `<mosaica-explorer>` does
- * in its sidebar. Each filter or highlight in force shows as a chip above the cards, and pressing a
- * chip opens its field's card.
+ * in its sidebar. Each filter or highlight in force shows as a chip above the cards, a highlight's
+ * with a pen on it, and pressing a chip opens its field's card. When a chip is removed, focus
+ * moves to the × of the chip after it, else of the one before, else to Add field. Under
+ * `chips-only` there is no Add field, so when the last chip is removed the panel shows the words
+ * No filters, which take focus and go as focus leaves them; a chip that arrives while they hold
+ * focus takes it on its ×.
+ *
+ * A region selected in another view keeps filtering after the viewer switches away from it, and
+ * shows as a chip naming its view, such as "Lasso in Topics". Pressing the chip switches back to
+ * that view, where the region is selected again, and its × removes it.
  *
  * The row at the top says what the cards' solid bars count. That is the items in view that the
  * filters match, or the highlighted items while there is a highlight. The pale bars count
@@ -17,6 +25,10 @@ export declare function clusterFieldLayers(meta: Meta, view: string): Layer[];
  * highlight, and for the field the map is coloured by. Viewers add other fields with Add field.
  * Taking a card off clears that field's filters and highlights.
  *
+ * The panel sets `hide-chips` on the cards it shows, so that a layer's card does not repeat the
+ * chips the panel shows for its clauses. Under `controls-only` the panel shows no chips, and the
+ * cards keep theirs.
+ *
  * Set `chips-only` on one panel and `controls-only` on another when you want the chips apart from
  * the cards.
  *
@@ -27,6 +39,10 @@ export declare function clusterFieldLayers(meta: Meta, view: string): Layer[];
  *   column's chip was removed, Clear all was pressed, the highlight was cleared from the subject
  *   row, or a card was taken off in Add field. Removing a `member_of` chip fires nothing. Each card
  *   fires its own as well.
+ * @fires {CustomEvent<MosaicaEventDetails['mosaica-selectchange']>} mosaica-selectchange - The chip
+ *   of a region held in another view was removed, or Clear all removed one, with that `view`.
+ * @fires {CustomEvent<MosaicaEventDetails['mosaica-viewswitch']>} mosaica-viewswitch - The chip of
+ *   a region held in another view was pressed, and the panel switched to that view.
  * @fires {CustomEvent<MosaicaEventDetails['mosaica-chipopen']>} mosaica-chipopen - A column's chip
  *   was pressed while `chips-only` is set, so you can show its card.
  * @csspart state - The state line, with `data-state`.
@@ -39,15 +55,18 @@ export declare function clusterFieldLayers(meta: Meta, view: string): Layer[];
  * @csspart clear-highlight - The × beside Highlighted, which clears the highlight.
  * @csspart all - All matching and its number.
  * @csspart all-count - The number matching.
- * @csspart chips - The line of chips, while any filter or highlight is in force.
- * @csspart chip - One chip, with `data-verb` (`filter` or `highlight`) and `data-column` or
- *   `data-artifact`.
- * @csspart edit - A column chip's text, a button that opens its card.
+ * @csspart chips - The line of chips, while any filter or highlight is in force, and under
+ *   `chips-only` the words that stand in it after the last chip is removed.
+ * @csspart chip - One chip, with `data-verb` (`filter` or `highlight`) and `data-column`,
+ *   `data-artifact`, or `data-view` for a region held in another view.
+ * @csspart edit - A column chip's text, a button that opens its card; on a held region's chip, a
+ *   button that switches to its view.
  * @csspart clear - The Clear all button.
  * @csspart card - One `<mosaica-field-card>`, with `data-field`.
  * @csspart add - The Add field button, with `aria-expanded`.
  * @csspart add-note - How many fields are not listed.
- * @csspart add-list - The list of fields to add, while it is open.
+ * @csspart add-list - The list of fields to add, while it is open. A press outside it, or focus
+ *   leaving it, closes it.
  * @csspart add-search - The search box over that list.
  * @csspart add-option - One field in that list, with `data-column` or `data-layer`, `aria-checked`
  *   while its card is shown, and `aria-disabled` if it is pinned and cannot be taken off.
@@ -68,8 +87,12 @@ export declare class MosaicaFilterPanel extends MosaicaElement {
     accessor pinned: string;
     /** Keeps one card open at a time, and shortens the subject row's figures. */
     accessor compact: boolean;
-    /** The level that cards for layers with levels count at. `null` is the coarsest level. */
-    accessor clusterLevel: number | null;
+    /**
+     * The level each card for a `stacked` or `tiered` layer counts at, keyed by layer name. A layer
+     * with no entry counts at the level the map draws it at, which follows the zoom where its levels
+     * declare no zoom range. Set it as a property; it has no attribute.
+     */
+    accessor clusterLevels: ReadonlyMap<string, number>;
     /** The fields the user added, which stay listed. @internal */
     accessor opened: ReadonlySet<string>;
     /** The cards the user folded, outside the compact layout. @internal */
@@ -87,6 +110,12 @@ export declare class MosaicaFilterPanel extends MosaicaElement {
     private readonly matching;
     /** The card to open, scroll to and focus once the cards are drawn. */
     private editing;
+    /** A pressed control that its own action removes, and the control that takes focus once it has gone. */
+    private leaving;
+    /** Whether the last chip was removed from a panel with nothing else to focus, which then says so. @internal */
+    accessor emptied: boolean;
+    /** Whether those words held focus as a render began. */
+    private wordsHeld;
     /** The keys of the fields shown, in the order they were first shown. */
     private listOrder;
     private readonly floating;
@@ -100,6 +129,18 @@ export declare class MosaicaFilterPanel extends MosaicaElement {
     protected onStoreChange(): void;
     protected onStoreAdopted(): void;
     disconnectedCallback(): void;
+    /** A press outside the open Add field list closes it, as Escape does. */
+    private onPressOutsideAdd;
+    /**
+     * Before an action that removes the pressed control `gone`, note where focus goes once it has.
+     * From a chip's ×, to the × of the chip after it, else of the chip before, as each stands then.
+     * From there, and from Clear all and the clear-highlight ×, to Add field: a × that took focus
+     * unasked would remove a filter on the next press. Under `chips-only`, which has no Add field, to
+     * the words that say no filter is left.
+     */
+    private leave;
+    /** Move focus as {@link leave} noted, once the pressed control has gone and taken focus with it. */
+    private settleFocus;
     /** Show `field`'s card, open it, and scroll to and focus it. Call it after `mosaica-chipopen` to show the chip's card. */
     show(field: string): void;
     /** Moves focus to the first card's search box or plot, else Add field. */
@@ -114,9 +155,12 @@ export declare class MosaicaFilterPanel extends MosaicaElement {
     private chipText;
     /**
      * A `member_of` chip's text: the clause's own label (the only name a filter layer's artifact has,
-     * since it is not served), else the served name, else unnamed.
+     * since it is not served), else the served name or key, else unnamed.
      */
     private memberText;
+    /** Switch to the view a held region is in, where the store selects it again. */
+    private showRegion;
+    private clearRegion;
     private clearMember;
     private clearColumn;
     private clearAll;