@nubisco/ui 2.1.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -198,11 +198,12 @@ Most component libraries impose styling opinions that are hard to override. Nubi
198
198
 
199
199
  ### Data Display
200
200
 
201
- | Component | Description |
202
- | :----------- | :-------------------------------------------- |
203
- | `NbBadge` | Status badge/pill with 7 colour variants |
204
- | `NbIcon` | SVG icon component with virtual module loader |
205
- | `NbJsonTree` | Collapsible JSON tree viewer |
201
+ | Component | Description |
202
+ | :-------------- | :-------------------------------------------------------------------------------------------- |
203
+ | `NbBadge` | Status badge/pill with 7 colour variants |
204
+ | `NbIcon` | SVG icon component with virtual module loader |
205
+ | `NbJsonTree` | Collapsible JSON tree viewer |
206
+ | `NbNubiscoMark` | The Nubisco mark, inline SVG. Also shipped as a file at `@nubisco/ui/assets/nubisco-mark.svg` |
206
207
 
207
208
  ### Navigation
208
209
 
@@ -0,0 +1,16 @@
1
+ interface INubiscoMarkProps {
2
+ /**
3
+ * Rendered edge length. A number is taken as pixels; a string is passed to
4
+ * CSS as given, so `'1.5rem'` and `'100%'` both work.
5
+ */
6
+ size?: number | string
7
+ /**
8
+ * Accessible name. Provide it when the mark carries meaning on its own (a
9
+ * bare logo link, a splash screen). Omit it when adjacent text already names
10
+ * the product, and the mark is hidden from assistive technology instead of
11
+ * being announced twice.
12
+ */
13
+ title?: string
14
+ }
15
+
16
+ export { INubiscoMarkProps }
@@ -0,0 +1,8 @@
1
+ import type { INubiscoMarkProps } from './NubiscoMark.d';
2
+ declare const __VLS_export: import("vue").DefineComponent<INubiscoMarkProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<INubiscoMarkProps> & Readonly<{}>, {
3
+ size: number | string;
4
+ title: string;
5
+ }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
6
+ declare const _default: typeof __VLS_export;
7
+ export default _default;
8
+ //# sourceMappingURL=NubiscoMark.vue.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NubiscoMark.vue.d.ts","sourceRoot":"","sources":["../../src/components/NubiscoMark.vue"],"names":[],"mappings":"AAmQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAoXxD,QAAA,MAAM,YAAY;;;6EAGhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}
@@ -16,6 +16,15 @@ interface IUserMenuAccount {
16
16
 
17
17
  type TUserMenuPlacement = 'right-end' | 'top-start'
18
18
 
19
+ /**
20
+ * How the menu signs itself as a Nubisco Platform product.
21
+ *
22
+ * A union rather than a boolean because a third mode, `'hub'` (the same
23
+ * lockup, but a real link to the Nubisco Platform product page), lands once
24
+ * that page exists.
25
+ */
26
+ type TUserMenuBrand = 'footer' | 'none'
27
+
19
28
  interface IUserMenuProps {
20
29
  /** The identity the product is signed in as (header of the menu). */
21
30
  user: IUserMenuUser
@@ -35,9 +44,21 @@ interface IUserMenuProps {
35
44
  showAccountActions?: boolean
36
45
  /** Hide the Profile entry when the product has no profile page. */
37
46
  showProfile?: boolean
47
+ /**
48
+ * The Nubisco Platform lockup at the foot of the panel. `'footer'` renders a
49
+ * non-interactive signature; `'none'` renders nothing, for white-label
50
+ * deployments and for hosts that are not Nubisco products.
51
+ */
52
+ brand?: TUserMenuBrand
38
53
  /** Where the panel opens relative to the trigger. */
39
54
  placement?: TUserMenuPlacement
40
55
  disabled?: boolean
41
56
  }
42
57
 
43
- export { IUserMenuUser, IUserMenuAccount, TUserMenuPlacement, IUserMenuProps }
58
+ export {
59
+ IUserMenuUser,
60
+ IUserMenuAccount,
61
+ TUserMenuPlacement,
62
+ TUserMenuBrand,
63
+ IUserMenuProps,
64
+ }
@@ -6,11 +6,13 @@ declare var __VLS_1: {
6
6
  toggle: typeof toggle;
7
7
  }, __VLS_37: {
8
8
  close: typeof close;
9
- };
9
+ }, __VLS_49: {};
10
10
  type __VLS_Slots = {} & {
11
11
  trigger?: (props: typeof __VLS_1) => any;
12
12
  } & {
13
13
  default?: (props: typeof __VLS_37) => any;
14
+ } & {
15
+ brand?: (props: typeof __VLS_49) => any;
14
16
  };
15
17
  declare const __VLS_base: import("vue").DefineComponent<IUserMenuProps, {
16
18
  open: import("vue").Ref<boolean, boolean>;
@@ -41,6 +43,7 @@ declare const __VLS_base: import("vue").DefineComponent<IUserMenuProps, {
41
43
  accountsUnknown: boolean;
42
44
  showAccountActions: boolean;
43
45
  showProfile: boolean;
46
+ brand: import("./UserMenu.d").TUserMenuBrand;
44
47
  }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
45
48
  declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
46
49
  declare const _default: typeof __VLS_export;
@@ -1 +1 @@
1
- {"version":3,"file":"UserMenu.vue.d.ts","sourceRoot":"","sources":["../../src/components/UserMenu.vue"],"names":[],"mappings":"AA8bA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAiGpE,iBAAS,MAAM,SASd;AAED,iBAAS,KAAK,SAIb;AAmWD,QAAA,IAAI,OAAO;;;CAAU,EAAE,QAAQ;;CAAY,CAAE;AAC7C,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,GAC5C;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,CAAC;AAQhD,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6EAKd,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AAWzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}
1
+ {"version":3,"file":"UserMenu.vue.d.ts","sourceRoot":"","sources":["../../src/components/UserMenu.vue"],"names":[],"mappings":"AAqfA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAiHpE,iBAAS,MAAM,SASd;AAED,iBAAS,KAAK,SAIb;AA0YD,QAAA,IAAI,OAAO;;;CAAU,EAAE,QAAQ;;CAAW,EAAE,QAAQ,IAAY,CAAE;AAClE,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,GAC5C;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,GAC7C;IAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,CAAC;AAQ9C,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6EAKd,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AAWzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;;iBAwIf,GAAG;;AADlB,wBAMC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;;iBA0If,GAAG;;AADlB,wBAMC"}
package/dist/global.d.ts CHANGED
@@ -42,6 +42,7 @@ import MenuDivider from './components/MenuDivider.vue'
42
42
  import MenuItem from './components/MenuItem.vue'
43
43
  import Message from './components/Message.vue'
44
44
  import Modal from './components/Modal.vue'
45
+ import NubiscoMark from './components/NubiscoMark.vue'
45
46
  import NumberInput from './components/NumberInput.vue'
46
47
  import Pagination from './components/Pagination.vue'
47
48
  import Panel from './components/Panel.vue'
@@ -113,6 +114,7 @@ declare module 'vue' {
113
114
  NbMenuItem: typeof MenuItem
114
115
  NbMessage: typeof Message
115
116
  NbModal: typeof Modal
117
+ NbNubiscoMark: typeof NubiscoMark
116
118
  NbNumberInput: typeof NumberInput
117
119
  NbPagination: typeof Pagination
118
120
  NbPanel: typeof Panel