rei-kit 2.18.1 → 2.20.0

package/dist/web/BaseHoverCard.vue.d.ts

@@ -0,0 +1,67 @@
+/**
+ * A card that appears beside something when you rest on it.
+ *
+ * ## `BaseHoverCard` or `BaseTooltip`
+ *
+ * A tooltip is a sentence naming what a control does, and it is wired with
+ * `aria-describedby` — which flattens whatever is inside it to text. That
+ * is right for a sentence and wrong for anything else: a card holding a
+ * name, an avatar and a link would be read as one run-on string, and the
+ * link inside it could not be reached at all.
+ *
+ * So this is not a described-by bubble. The trigger says a popup is there
+ * with `aria-expanded` and `aria-controls`; the card is an ordinary region
+ * of the page that happens to be revealed, and everything inside it stays
+ * reachable.
+ *
+ * Reach for the tooltip when the answer is a sentence. Reach for this when
+ * the answer is a *thing* — a profile, a preview of what a link leads to, a
+ * definition with a source.
+ *
+ * ## The pointer has to be able to get there
+ *
+ * A card that vanishes the moment the pointer leaves the trigger is a card
+ * whose contents can never be used: the gap between the two is enough to
+ * close it. So leaving starts a delay rather than closing, and entering the
+ * card cancels it. That delay is the whole reason this is a component
+ * instead of two CSS rules.
+ *
+ * ## It opens without a pointer too
+ *
+ * Focus opens it, with no delay — waiting makes sense for a pointer sweeping
+ * across a page, and no sense for somebody who deliberately tabbed onto it.
+ * Escape closes it while leaving focus where it is, so a keyboard is never
+ * stuck with a card in the way.
+ *
+ * A hover card is supplementary by definition: everything in it has to be
+ * reachable some other way, because a touch screen has no hover at all.
+ */
+type __VLS_Props = {
+    /** Names the card for a screen reader. Already translated. */
+    label: string;
+    /** How long a pointer has to rest before it opens, in ms. */
+    openDelay?: number | undefined;
+    /** How long it survives the pointer leaving, so the card can be reached. */
+    closeDelay?: number | undefined;
+    placement?: 'top' | 'bottom' | undefined;
+};
+type __VLS_Slots = {
+    /** The thing being rested on. `props` says a popup is here. */
+    default: (props: {
+        props: {
+            'aria-expanded': boolean;
+            'aria-controls': string | undefined;
+        };
+    }) => unknown;
+    /** What appears: a profile, a preview, a definition. */
+    card: () => unknown;
+};
+declare const __VLS_base: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/web/index.d.ts

@@ -24,7 +24,22 @@ export type { Crumb } from './BaseBreadcrumb.vue';
  * scrolls in, interleaved with something else, or built from a source the
  * accordion cannot know about.
  */
+/**
+ * `BaseContextMenu`, the right-click menu — which is also Shift+F10 and the
+ * Menu key, or it is a set of actions a keyboard cannot reach at all.
+ */
+export { default as BaseContextMenu } from './BaseContextMenu.vue';
 export { default as BaseDisclosure } from './BaseDisclosure.vue';
+/**
+ * `BaseHoverCard`, for when the answer is a thing rather than a sentence —
+ * which is where `aria-describedby`, and so `BaseTooltip`, stops working.
+ */
+export { default as BaseHoverCard } from './BaseHoverCard.vue';
+/**
+ * `BaseDrawer`, the wide screen's answer to `BaseSheet`: a panel from the
+ * edge, for what a site keeps beside the page rather than on top of it.
+ */
+export { default as BaseDrawer } from './BaseDrawer.vue';
 /**
  * `BaseModal`, beside `BaseSheet` rather than named `Modal` on its own.
  *