@nubisco/ui 3.2.0 → 3.4.0

package/dist/directives/ToolTip.directive.d.ts

@@ -1,17 +1,96 @@
-import type { App } from 'vue';
+import type { App, ObjectDirective } from 'vue';
 import type { IComponentContent } from '../types/ContentRenderer';
 export interface ITooltipOptions {
-    body?: string | Array<IComponentContent>;
-    header?: string | Array<IComponentContent>;
-    tip?: string | Array<IComponentContent>;
-    flavor?: string;
+    /** The three content slots accept `null` as well as `undefined`, because an
+     *  application binding a value straight from its state (`projectPath`, a
+     *  fetched description, an optional field) usually has `string | null` and
+     *  the runtime has always treated any falsy value as "no tooltip" via
+     *  `hasContent`. Rejecting `null` in the type while accepting it at runtime
+     *  only forced `?? undefined` at every call site. Found by type-checking
+     *  `v-nb-tooltip` in a real consumer for the first time. */
+    body?: string | Array<IComponentContent> | null;
+    header?: string | Array<IComponentContent> | null;
+    tip?: string | Array<IComponentContent> | null;
+    /** The chip's tone, from the same vocabulary the rest of the library uses
+     *  (`NbBanner.status`, `EVariant`). `default` is the inverted chip and is
+     *  what a labelling tooltip should stay on: a coloured chip on a plain icon
+     *  button reads as a state the control does not have. Reach for `danger` or
+     *  `warning` only when the tooltip is explaining a blocked or destructive
+     *  action, which is the case the fleet actually has. */
+    status?: TTooltipStatus;
+    /** @deprecated Use `status`. Kept because it is the name every existing
+     *  binding uses and removing it would break them silently. `status` wins
+     *  when both are given. Typed now, where it used to be `string`: the four
+     *  values that were only ever documented are now the four the compiler
+     *  accepts, plus `success` and `warning`, which the library's own status
+     *  vocabulary has and this directive was missing. */
+    flavor?: TTooltipStatus;
     delay?: number;
+    /** Milliseconds the chip stays up after the pointer or focus leaves.
+     *  Defaults to 150. Raise it when the anchor sits next to a target the
+     *  user must cross to reach, lower it for dense toolbars. */
+    hideDelay?: number;
+    /** How the tooltip is wired to assistive technology.
+     *  - `label`: the tooltip IS the anchor's accessible name (icon-only
+     *    controls). Applied as a permanent `aria-label`, because a name that
+     *    only exists while a chip is on screen is not a name.
+     *  - `description`: the tooltip adds to an anchor that is already named.
+     *    Applied as `aria-describedby` on the visible chip only.
+     *  - `none`: no aria wiring at all. For decorative or duplicated text.
+     *  - `auto` (default): `label` when the anchor has no accessible name,
+     *    `description` when it does. */
+    aria?: TTooltipAria;
+    /** Add `tabindex="0"` to an anchor that cannot otherwise take focus, so
+     *  keyboard users can reach the tooltip. Only for anchors that carry
+     *  information nothing else conveys (a truncated cell, a status dot).
+     *  Never needed on a button or a link. */
+    focusable?: boolean;
+    /** Open on touch (tap) as well as hover and focus. Default true. */
+    touch?: boolean;
     animationTime?: number;
     position?: 'top' | 'bottom' | 'left' | 'right' | 'cursor';
     followCursor?: boolean;
     overflowOnly?: boolean;
+    /** Extra classes for the CHIP (not for the anchor, which keeps its own
+     *  `class` attribute untouched). Use it for a one-off width or a product
+     *  skin; the supported knobs are the three custom properties in the docs. */
+    chipClass?: string;
+    /** @deprecated Use `chipClass`, which says which element it lands on.
+     *  `classExtra` is a name nothing else in this library uses. */
     classExtra?: string;
+    /** Controlled visibility. When this is a boolean, the chip is on screen if
+     *  and only if it is `true`, and hover / focus / tap stop opening and
+     *  closing it themselves: they report what the user did through
+     *  `onOpenChange` and leave the decision to you. This is what an onboarding
+     *  highlight, a "show me" button and a visual-regression snapshot of the
+     *  open state need, and there was previously no way to get any of them
+     *  without synthesising MouseEvents. Leave it `undefined` for the ordinary
+     *  uncontrolled tooltip. */
+    open?: boolean;
+    /** Open once, on mount, and behave normally afterwards. Uncontrolled: the
+     *  first hover-out closes it for good. For a hint that should be seen once
+     *  without taking the tooltip away from the user. */
+    defaultOpen?: boolean;
+    /** Called on every transition, with what caused it. In controlled mode this
+     *  is the only way the user's pointer and keyboard reach you. */
+    onOpenChange?: (open: boolean, reason: TTooltipReason) => void;
 }
+export type TTooltipAria = 'auto' | 'label' | 'description' | 'none';
+/** What opened a chip. `program` is a controlled or `defaultOpen` show, which
+ *  never waits out the hover-intent delay. */
+export type TTooltipTrigger = 'pointer' | 'focus' | 'touch' | 'program';
+/** What caused a transition reported through `onOpenChange`.
+ *  - `dismiss`: the user got rid of it. Escape, a pointerdown outside, the
+ *    window losing focus, a drag starting, the anchor scrolling out of sight.
+ *  - `superseded`: another anchor opened a chip, and only one chip is ever on
+ *    screen. Nothing the user did was a dismissal OF THIS tooltip, which is
+ *    why it is not called one: a host that treats every `false` as "the user
+ *    is done with this hint" would otherwise cancel an onboarding highlight
+ *    the moment the pointer crossed an unrelated icon button. */
+export type TTooltipReason = TTooltipTrigger | 'dismiss' | 'superseded';
+/** The chip's tone. Same words as `NbBanner.status` and `EVariant`, minus the
+ *  ones a 55-character chip has no use for. */
+export type TTooltipStatus = 'default' | 'primary' | 'info' | 'success' | 'warning' | 'danger';
 declare const tooltipDirective: (app: App) => void;
 /** Dismiss every currently-visible tooltip. Useful for view switches
  *  in single-page apps where the trigger element gets unmounted by a
@@ -19,9 +98,16 @@ declare const tooltipDirective: (app: App) => void;
  *  tooltip element about to be appended) leaves orphan chips behind.
  *  Call from the host on route / view change.
  *
- *  Exposed via `useTooltip()` (composable) and `Tooltip.dismissAll`
- *  (named export) so consumers don't need to dig through registered
- *  state directly. */
+ *  Exported by name from the library entry, alongside the directive
+ *  installer, so consumers do not have to reach into registered state. */
 export declare function dismissAllTooltips(): void;
+export type TTooltipDirective = ObjectDirective<HTMLElement, ITooltipOptions>;
+declare module 'vue' {
+    interface GlobalDirectives {
+        /** Attach a tooltip to any element. See `ITooltipOptions` for the
+         *  binding value: at minimum one of `header`, `body` or `tip`. */
+        vNbTooltip: TTooltipDirective;
+    }
+}
 export default tooltipDirective;
 //# sourceMappingURL=ToolTip.directive.d.ts.map

package/dist/directives/ToolTip.directive.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ToolTip.directive.d.ts","sourceRoot":"","sources":["../../src/directives/ToolTip.directive.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAoB,MAAM,KAAK,CAAA;AAEhD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAgChE,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACxC,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAC1C,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAA;IACzD,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAuKD,QAAA,MAAM,gBAAgB,GAAI,KAAK,GAAG,SAkGjC,CAAA;AAkTD;;;;;;;;sBAQsB;AACtB,wBAAgB,kBAAkB,SASjC;AAED,eAAe,gBAAgB,CAAA"}
+{"version":3,"file":"ToolTip.directive.d.ts","sourceRoot":"","sources":["../../src/directives/ToolTip.directive.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAoB,eAAe,EAAE,MAAM,KAAK,CAAA;AAEjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAuGhE,MAAM,WAAW,eAAe;IAC9B;;;;;;gEAM4D;IAC5D,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAA;IAC/C,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAA;IACjD,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAA;IAC9C;;;;;4DAKwD;IACxD,MAAM,CAAC,EAAE,cAAc,CAAA;IACvB;;;;;yDAKqD;IACrD,MAAM,CAAC,EAAE,cAAc,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;iEAE6D;IAC7D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;;;;wCAQoC;IACpC,IAAI,CAAC,EAAE,YAAY,CAAA;IACnB;;;8CAG0C;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,oEAAoE;IACpE,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAA;IACzD,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;iFAE6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;oEACgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;;;;gCAO4B;IAC5B,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;yDAEqD;IACrD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;qEACiE;IACjE,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,KAAK,IAAI,CAAA;CAC/D;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,MAAM,CAAA;AACpE;8CAC8C;AAC9C,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;AACvE;;;;;;;iEAOiE;AACjE,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,SAAS,GAAG,YAAY,CAAA;AACvE;+CAC+C;AAC/C,MAAM,MAAM,cAAc,GACtB,SAAS,GACT,SAAS,GACT,MAAM,GACN,SAAS,GACT,SAAS,GACT,QAAQ,CAAA;AA83BZ,QAAA,MAAM,gBAAgB,GAAI,KAAK,GAAG,SAyQjC,CAAA;AAsgBD;;;;;;;0EAO0E;AAC1E,wBAAgB,kBAAkB,SAmBjC;AAeD,MAAM,MAAM,iBAAiB,GAAG,eAAe,CAAC,WAAW,EAAE,eAAe,CAAC,CAAA;AAE7E,OAAO,QAAQ,KAAK,CAAC;IAInB,UAAU,gBAAgB;QACxB;0EACkE;QAClE,UAAU,EAAE,iBAAiB,CAAA;KAC9B;CACF;AAED,eAAe,gBAAgB,CAAA"}

package/dist/global.d.ts

@@ -24,6 +24,7 @@ import Checkbox from './components/Checkbox.vue'
 import CheckboxGroup from './components/CheckboxGroup.vue'
 import ColorStrip from './components/ColorStrip.vue'
 import CommandPalette from './components/CommandPalette.vue'
+import Confirm from './components/Confirm.vue'
 import DataTable from './components/DataTable.vue'
 import DatePicker from './components/DatePicker.vue'
 import DefinitionList from './components/DefinitionList.vue'
@@ -38,6 +39,8 @@ import Grid from './components/Grid.vue'
 import Icon from './components/Icon.vue'
 import ImageCropper from './components/ImageCropper.vue'
 import InfoHint from './components/InfoHint.vue'
+import InlineEdit from './components/InlineEdit.vue'
+import InlineLoading from './components/InlineLoading.vue'
 import InterpolationChart from './components/Charts/InterpolationChart.vue'
 import JsonTree from './components/JsonTree.vue'
 import Label from './components/Label.vue'
@@ -50,6 +53,8 @@ import MenuDivider from './components/MenuDivider.vue'
 import MenuItem from './components/MenuItem.vue'
 import Message from './components/Message.vue'
 import Modal from './components/Modal.vue'
+import NotificationCenter from './components/NotificationCenter.vue'
+import NotificationCenterItem from './components/NotificationCenterItem.vue'
 import NubiscoMark from './components/NubiscoMark.vue'
 import NubiscoPlatformMark from './components/NubiscoPlatformMark.vue'
 import NumberInput from './components/NumberInput.vue'
@@ -68,14 +73,19 @@ import SidebarMenu from './components/SidebarMenu.vue'
 import SidebarMenuGroup from './components/SidebarMenuGroup.vue'
 import SidebarMenuItem from './components/SidebarMenuItem.vue'
 import SidebarVariantScope from './components/SidebarVariantScope.vue'
+import Skeleton from './components/Skeleton.vue'
 import Slider from './components/Slider.vue'
 import Sparkline from './components/Charts/Sparkline.vue'
+import Spinner from './components/Spinner.vue'
+import Stepper from './components/Stepper.vue'
+import StepperStep from './components/StepperStep.vue'
 import Submenu from './components/Submenu.vue'
 import SurfaceLayerScope from './components/SurfaceLayerScope.vue'
 import Switch from './components/Switch.vue'
 import Tabs from './components/Tabs.vue'
 import TextInput from './components/TextInput.vue'
 import Toast from './components/Toast.vue'
+import Toaster from './components/Toaster.vue'
 import Tree from './components/Tree.vue'
 import TreeNode from './components/TreeNode.vue'
 import UserMenu from './components/UserMenu.vue'
@@ -107,6 +117,7 @@ declare module 'vue' {
     NbCheckboxGroup: typeof CheckboxGroup
     NbColorStrip: typeof ColorStrip
     NbCommandPalette: typeof CommandPalette
+    NbConfirm: typeof Confirm
     NbDataTable: typeof DataTable
     NbDatePicker: typeof DatePicker
     NbDefinitionList: typeof DefinitionList
@@ -121,6 +132,8 @@ declare module 'vue' {
     NbIcon: typeof Icon
     NbImageCropper: typeof ImageCropper
     NbInfoHint: typeof InfoHint
+    NbInlineEdit: typeof InlineEdit
+    NbInlineLoading: typeof InlineLoading
     NbInterpolationChart: typeof InterpolationChart
     NbJsonTree: typeof JsonTree
     NbLabel: typeof Label
@@ -133,6 +146,8 @@ declare module 'vue' {
     NbMenuItem: typeof MenuItem
     NbMessage: typeof Message
     NbModal: typeof Modal
+    NbNotificationCenter: typeof NotificationCenter
+    NbNotificationCenterItem: typeof NotificationCenterItem
     NbNubiscoMark: typeof NubiscoMark
     NbNubiscoPlatformMark: typeof NubiscoPlatformMark
     NbNumberInput: typeof NumberInput
@@ -151,14 +166,19 @@ declare module 'vue' {
     NbSidebarMenuGroup: typeof SidebarMenuGroup
     NbSidebarMenuItem: typeof SidebarMenuItem
     NbSidebarVariantScope: typeof SidebarVariantScope
+    NbSkeleton: typeof Skeleton
     NbSlider: typeof Slider
     NbSparkline: typeof Sparkline
+    NbSpinner: typeof Spinner
+    NbStepper: typeof Stepper
+    NbStepperStep: typeof StepperStep
     NbSubmenu: typeof Submenu
     NbSurfaceLayerScope: typeof SurfaceLayerScope
     NbSwitch: typeof Switch
     NbTabs: typeof Tabs
     NbTextInput: typeof TextInput
     NbToast: typeof Toast
+    NbToaster: typeof Toaster
     NbTree: typeof Tree
     NbTreeNode: typeof TreeNode
     NbUserMenu: typeof UserMenu