@imfusion/web-ui 0.8.1-dev.2.g74f81c31 → 0.8.1-dev.3.g40eaad1c

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.
@@ -0,0 +1,3 @@
1
+ import { ReactNode } from 'react';
2
+ /** Inserts `<wbr>` before each `@` and after each `.` of string children, so an email wraps at its seams. */
3
+ export declare function withBreakHints(children: ReactNode): ReactNode;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@imfusion/web-ui",
3
- "version": "0.8.1-dev.2.g74f81c31",
3
+ "version": "0.8.1-dev.3.g40eaad1c",
4
4
  "description": "The official Web UI component library for ImFusion web apps",
5
5
  "author": "ImFusion GmbH",
6
6
  "homepage": "https://imfusion.com",
@@ -2,7 +2,7 @@
2
2
  "account-card": {
3
3
  "root": {
4
4
  "name": "AccountCard.Root",
5
- "description": "AccountCard.Root — the link to the signed-in person's account, holding `AccountCard.Avatar`, `AccountCard.Title`, and\n`AccountCard.Description`. Pass a router link through `render`. `aria-current=\"page\"` marks it current with a tint and\nan inset rule. Its accessible name is the title and description; the avatar stays decorative.\n\nPlace `AccountCard.Action` beside the root, not inside it: a link cannot contain a button.",
5
+ "description": "AccountCard.Root — the signed-in person's card: `AccountCard.Link` and, in its top row, `AccountCard.Action`. The\naction sits beside the link, not inside it, since a link cannot contain a button.",
6
6
  "props": [
7
7
  {
8
8
  "name": "context",
@@ -10,27 +10,13 @@
10
10
  "type": "\"default\" | \"oncolor\" | null",
11
11
  "defaultValue": "default",
12
12
  "description": ""
13
- },
14
- {
15
- "name": "ref",
16
- "required": false,
17
- "type": "Ref<HTMLAnchorElement>",
18
- "defaultValue": null,
19
- "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
20
- },
21
- {
22
- "name": "render",
23
- "required": false,
24
- "type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, {}>",
25
- "defaultValue": null,
26
- "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
27
13
  }
28
14
  ]
29
15
  },
30
16
  "subComponents": [
31
17
  {
32
18
  "name": "AccountCard.Action",
33
- "description": "AccountCard.Action — a trailing slot beside `AccountCard.Root`, such as a ghost icon `Button` that logs out. The\nbutton carries its own `aria-label` and its own `context`.",
19
+ "description": "AccountCard.Action — a slot in the card's top row, beside the link, such as a ghost icon `Button` that logs out. The\nbutton carries its own `aria-label` and its own `context`.",
34
20
  "props": []
35
21
  },
36
22
  {
@@ -55,12 +41,47 @@
55
41
  },
56
42
  {
57
43
  "name": "AccountCard.Description",
58
- "description": "AccountCard.Description — a second line such as organization and role. Truncates to one line.",
44
+ "description": "AccountCard.Description — the organization, under a rule at the foot of the card.",
45
+ "props": []
46
+ },
47
+ {
48
+ "name": "AccountCard.Group",
49
+ "description": "AccountCard.Group — a list of cards, such as accounts to switch between. Inside it a link with `aria-current=\"page\"`\nshows as current; a standalone card is always the signed-in account and shows no current state.",
50
+ "props": []
51
+ },
52
+ {
53
+ "name": "AccountCard.Link",
54
+ "description": "AccountCard.Link — the link to the account, holding `AccountCard.Avatar`, `AccountCard.Title`,\n`AccountCard.Subtitle`, `AccountCard.Description`, and `AccountCard.Role`. Pass a router link through `render`. Its\naccessible name is its text; the avatar stays decorative.",
55
+ "props": [
56
+ {
57
+ "name": "ref",
58
+ "required": false,
59
+ "type": "Ref<HTMLAnchorElement>",
60
+ "defaultValue": null,
61
+ "description": "Allows getting a ref to the component instance.\nOnce the component unmounts, React will set `ref.current` to `null`\n(or call the ref with `null` if you passed a callback ref).\n@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}"
62
+ },
63
+ {
64
+ "name": "render",
65
+ "required": false,
66
+ "type": "| ReactElement<\n unknown,\n string | JSXElementConstructor<any>\n >\n| ComponentRenderFn<HTMLProps, {}>",
67
+ "defaultValue": null,
68
+ "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
69
+ }
70
+ ]
71
+ },
72
+ {
73
+ "name": "AccountCard.Role",
74
+ "description": "AccountCard.Role — a mono uppercase label beside the description, such as the person's role.",
75
+ "props": []
76
+ },
77
+ {
78
+ "name": "AccountCard.Subtitle",
79
+ "description": "AccountCard.Subtitle — the quiet line under the title: the email's domain, or the whole email once the title is a\nname. Text wraps before an `@` and after a dot.",
59
80
  "props": []
60
81
  },
61
82
  {
62
83
  "name": "AccountCard.Title",
63
- "description": "AccountCard.Title — the account's name, or its email until a name exists. Truncates to one line.",
84
+ "description": "AccountCard.Title — the account's name, or the email's local part until a name exists. Set large; text wraps before\nan `@` and after a dot.",
64
85
  "props": []
65
86
  }
66
87
  ]
@@ -11,7 +11,7 @@ props, which always live in the docgen file above.
11
11
 
12
12
  ## AccountCard
13
13
  - category: Display, status: experimental
14
- Link to the signed-in person's account, with avatar, name or email, and a second line such as organization and role. Also called an ID card or user row; for a bare person badge, use Avatar.
14
+ Card linking to the signed-in person's account: avatar, a large name or email, a quiet line under it, and organization and role at its foot, with a trailing action such as Log out. Also called an ID card or user row; for a bare person badge, use Avatar.
15
15
  - props: node_modules/@imfusion/web-ui/src/docgen/doc.gen.json -> .account-card (jq: jq '.account-card' node_modules/@imfusion/web-ui/src/docgen/doc.gen.json)
16
16
 
17
17
  ## AppShell