@substrat-run/elements 0.0.0-stage → 0.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/LICENSE +202 -0
- package/README.md +58 -2
- package/dist/avatar.d.ts +56 -0
- package/dist/avatar.d.ts.map +1 -0
- package/dist/avatar.js +107 -0
- package/dist/avatar.js.map +1 -0
- package/dist/controls.d.ts +21 -0
- package/dist/controls.d.ts.map +1 -0
- package/dist/controls.js +21 -0
- package/dist/controls.js.map +1 -0
- package/dist/entity-table-model.d.ts +269 -0
- package/dist/entity-table-model.d.ts.map +1 -0
- package/dist/entity-table-model.js +490 -0
- package/dist/entity-table-model.js.map +1 -0
- package/dist/entity-table.d.ts +187 -0
- package/dist/entity-table.d.ts.map +1 -0
- package/dist/entity-table.js +1004 -0
- package/dist/entity-table.js.map +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/dist/internal/session-controller.d.ts +29 -0
- package/dist/internal/session-controller.d.ts.map +1 -0
- package/dist/internal/session-controller.js +48 -0
- package/dist/internal/session-controller.js.map +1 -0
- package/dist/internal/substrat-element.d.ts +36 -0
- package/dist/internal/substrat-element.d.ts.map +1 -0
- package/dist/internal/substrat-element.js +195 -0
- package/dist/internal/substrat-element.js.map +1 -0
- package/dist/jsx.d.ts +8 -0
- package/dist/jsx.d.ts.map +1 -0
- package/dist/jsx.js +2 -0
- package/dist/jsx.js.map +1 -0
- package/dist/session.d.ts +84 -0
- package/dist/session.d.ts.map +1 -0
- package/dist/session.js +158 -0
- package/dist/session.js.map +1 -0
- package/dist/themes/atelier.css +59 -0
- package/dist/themes/base.css +7 -0
- package/dist/themes/ledger.css +59 -0
- package/dist/themes/native.css +11 -0
- package/dist/user-menu.d.ts +95 -0
- package/dist/user-menu.d.ts.map +1 -0
- package/dist/user-menu.js +212 -0
- package/dist/user-menu.js.map +1 -0
- package/package.json +47 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,59 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @substrat-run/elements
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Web components for a vertical's screens, built so a project gets a table that is good and
|
|
4
|
+
looks like *its* theme without writing either. Three components so far, dogfooded in
|
|
5
|
+
`demos/todo/app` (`#/table`, and its header). Still `0.x`: a minor release may change an
|
|
6
|
+
element's attributes or slots.
|
|
7
|
+
|
|
8
|
+
## What's in it
|
|
9
|
+
|
|
10
|
+
- **`<sub-entity-table>`** — the rows of one paged read: views, server-side sort, equality
|
|
11
|
+
filters, a search mode, Previous / Next paging with a rows-per-page picker (or `paging="more"`),
|
|
12
|
+
a selection with bulk actions, and the actions a row allows. `queryToParams` /
|
|
13
|
+
`queryFromParams` put its query in a URL and read it back; `column-picker` (opt-in) lets the
|
|
14
|
+
person show, hide and reorder columns, kept per browser with `layout-key`. Give it
|
|
15
|
+
a `source` (`{ read(query), follow, search? }` — the generated client's read, `follow` and
|
|
16
|
+
the entity's search read), `columns` and `actions`. It tells a 403 wall from an empty list
|
|
17
|
+
and "no matches" from both, keeps the rows when one action is refused, re-reads when an
|
|
18
|
+
action finds the view stale (409/404), follows `next` on "Load more", and drops `priority` 3,
|
|
19
|
+
then 2 columns while the table is wider than its frame. Cells are typed (`kind`), or drawn by
|
|
20
|
+
`render` (Lit) or `mount` (a light-DOM element, for React or Vue).
|
|
21
|
+
- **`<sub-user-menu>`** — the account menu: who is signed in, your own items (slotted
|
|
22
|
+
`<wa-dropdown-item>`s), then "Switch user" and "Sign out", which it owns because it knows
|
|
23
|
+
the auth endpoints (`/api/auth/*`). Every built-in part is a slot with a default, and
|
|
24
|
+
`sub-sign-out` / `sub-switch-user` are cancelable. Signed out it draws "Sign in"; before
|
|
25
|
+
the first session read it draws an empty circle, never "Sign in". `show="avatar|name|email"`.
|
|
26
|
+
- **`<sub-avatar>`** — the same identity without a menu: picture or initials (by grapheme,
|
|
27
|
+
coloured by principal), optionally the name or email beside it. Reads the session itself,
|
|
28
|
+
or draws the `session` property you hand it.
|
|
29
|
+
- **`SessionStore` / `sessionAt(url)`** — the session read both share: once per URL per
|
|
30
|
+
page, re-read when the tab comes back into view, and a failed refresh never signs
|
|
31
|
+
anybody out on screen.
|
|
32
|
+
- **`EntityTableModel`** — everything above that is not drawing, with no DOM in it, so a
|
|
33
|
+
second renderer (React Native, later) gets the same answers from the same code.
|
|
34
|
+
- **Themes** — `themes/base.css` is Web Awesome's default theme (the `--wa-*` tokens);
|
|
35
|
+
`themes/ledger.css` (dense, flat, cool) and `themes/atelier.css` (warm, serif headings,
|
|
36
|
+
roomy) are classes over it. A theme is token values only — no selectors into components.
|
|
37
|
+
|
|
38
|
+
## Using it
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
npm install @substrat-run/elements
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
import '@substrat-run/elements';
|
|
46
|
+
import '@substrat-run/elements/themes/base.css';
|
|
47
|
+
import '@substrat-run/elements/themes/ledger.css';
|
|
48
|
+
// <html class="sub-theme-ledger">, plus `wa-dark` for dark mode
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## How it is built
|
|
52
|
+
|
|
53
|
+
[Lit](https://lit.dev) elements on [Web Awesome](https://webawesome.com)'s free, MIT core:
|
|
54
|
+
its controls (`wa-button`, `wa-callout`, `wa-spinner`) inside, and its tokens for every
|
|
55
|
+
style, so an element follows any Web Awesome-shaped theme with no theme code of its own.
|
|
56
|
+
`src/internal/substrat-element.ts` is Web Awesome 3.14.0's base element, copied — upstream
|
|
57
|
+
marks it internal and leaves it out of the package's `exports` — with each change from
|
|
58
|
+
upstream listed in its header. Web Awesome's data grid, date picker, theme builder and
|
|
59
|
+
patterns are Pro; this package uses none of them.
|
package/dist/avatar.d.ts
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `<sub-avatar>` — who is signed in, as a picture or initials, and optionally their name
|
|
3
|
+
* or email beside it. No menu: a corner badge, a byline, a row in a member list.
|
|
4
|
+
*
|
|
5
|
+
* Reads the session itself (`SessionStore`, shared per URL, so many avatars on a page
|
|
6
|
+
* are one read), or draws the `session` property when the host already has one — a
|
|
7
|
+
* member list passes each member's. A picture that fails to load falls back to the
|
|
8
|
+
* initials, and the colour follows the principal, so it survives a rename.
|
|
9
|
+
*
|
|
10
|
+
* Attributes:
|
|
11
|
+
* `show` — `avatar` (default), `name` or `email`: what is written beside the picture
|
|
12
|
+
* `session-url` — the session read (default `/api/me`)
|
|
13
|
+
* `size` — any CSS length for the circle (default `2rem`)
|
|
14
|
+
* Property: `session` — a `Session`, or `null` for "nobody"; set, it replaces the read.
|
|
15
|
+
*
|
|
16
|
+
* While the first read is in flight it draws an empty circle of the same size, so the
|
|
17
|
+
* header does not jump when the answer lands.
|
|
18
|
+
*/
|
|
19
|
+
import '@awesome.me/webawesome/dist/components/avatar/avatar.js';
|
|
20
|
+
import { nothing } from 'lit';
|
|
21
|
+
import SubstratElement from './internal/substrat-element.js';
|
|
22
|
+
import { type Session, type SessionState } from './session.js';
|
|
23
|
+
export type AvatarShow = 'avatar' | 'name' | 'email';
|
|
24
|
+
export declare class SubAvatar extends SubstratElement {
|
|
25
|
+
#private;
|
|
26
|
+
static properties: {
|
|
27
|
+
show: {
|
|
28
|
+
reflect: boolean;
|
|
29
|
+
};
|
|
30
|
+
sessionUrl: {
|
|
31
|
+
attribute: string;
|
|
32
|
+
};
|
|
33
|
+
size: {};
|
|
34
|
+
session: {
|
|
35
|
+
attribute: boolean;
|
|
36
|
+
};
|
|
37
|
+
};
|
|
38
|
+
show: AvatarShow;
|
|
39
|
+
sessionUrl: string;
|
|
40
|
+
size: string;
|
|
41
|
+
/** `undefined`: read it. `null`: nobody. */
|
|
42
|
+
session: Session | null | undefined;
|
|
43
|
+
constructor();
|
|
44
|
+
/** What is drawn: the `session` property when set, the read otherwise. */
|
|
45
|
+
get state(): SessionState;
|
|
46
|
+
/** Read the session again (every element on that URL redraws). */
|
|
47
|
+
refresh(): Promise<void>;
|
|
48
|
+
static css: import("lit").CSSResult;
|
|
49
|
+
render(): typeof nothing | import("lit").TemplateResult<1>;
|
|
50
|
+
}
|
|
51
|
+
declare global {
|
|
52
|
+
interface HTMLElementTagNameMap {
|
|
53
|
+
'sub-avatar': SubAvatar;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=avatar.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"avatar.d.ts","sourceRoot":"","sources":["../src/avatar.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,yDAAyD,CAAC;AACjE,OAAO,EAAa,OAAO,EAAa,MAAM,KAAK,CAAC;AACpD,OAAO,eAAe,MAAM,gCAAgC,CAAC;AAE7D,OAAO,EAA2B,KAAK,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAExF,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;AAarD,qBAAa,SAAU,SAAQ,eAAe;;IAC5C,MAAM,CAAC,UAAU;QACf,IAAI;YAAI,OAAO;;QACf,UAAU;YAAI,SAAS;;QACvB,IAAI;QACJ,OAAO;YAAI,SAAS;;MACpB;IAEM,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACrB,4CAA4C;IACpC,OAAO,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAI5C,cAKC;IAED,0EAA0E;IAC1E,IAAI,KAAK,IAAI,YAAY,CAExB;IAED,kEAAkE;IAClE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAEvB;IAED,MAAM,CAAC,GAAG,0BA2BR;IAEF,MAAM,qDAmBL;CACF;AAID,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,YAAY,EAAE,SAAS,CAAC;KACzB;CACF"}
|
package/dist/avatar.js
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `<sub-avatar>` — who is signed in, as a picture or initials, and optionally their name
|
|
3
|
+
* or email beside it. No menu: a corner badge, a byline, a row in a member list.
|
|
4
|
+
*
|
|
5
|
+
* Reads the session itself (`SessionStore`, shared per URL, so many avatars on a page
|
|
6
|
+
* are one read), or draws the `session` property when the host already has one — a
|
|
7
|
+
* member list passes each member's. A picture that fails to load falls back to the
|
|
8
|
+
* initials, and the colour follows the principal, so it survives a rename.
|
|
9
|
+
*
|
|
10
|
+
* Attributes:
|
|
11
|
+
* `show` — `avatar` (default), `name` or `email`: what is written beside the picture
|
|
12
|
+
* `session-url` — the session read (default `/api/me`)
|
|
13
|
+
* `size` — any CSS length for the circle (default `2rem`)
|
|
14
|
+
* Property: `session` — a `Session`, or `null` for "nobody"; set, it replaces the read.
|
|
15
|
+
*
|
|
16
|
+
* While the first read is in flight it draws an empty circle of the same size, so the
|
|
17
|
+
* header does not jump when the answer lands.
|
|
18
|
+
*/
|
|
19
|
+
import '@awesome.me/webawesome/dist/components/avatar/avatar.js';
|
|
20
|
+
import { css, html, nothing, unsafeCSS } from 'lit';
|
|
21
|
+
import SubstratElement from './internal/substrat-element.js';
|
|
22
|
+
import { SessionController } from './internal/session-controller.js';
|
|
23
|
+
import { HUES, hueOf, initialsOf } from './session.js';
|
|
24
|
+
/**
|
|
25
|
+
* One rule per palette hue, both schemes in one declaration (`light-dark()` follows the
|
|
26
|
+
* `color-scheme` every Web Awesome theme sets), so dark mode needs no selector here.
|
|
27
|
+
*/
|
|
28
|
+
const HUE_RULES = HUES.map((h) => `wa-avatar[data-hue='${h}'] {
|
|
29
|
+
background-color: light-dark(var(--wa-color-${h}-80), var(--wa-color-${h}-30));
|
|
30
|
+
color: light-dark(var(--wa-color-${h}-20), var(--wa-color-${h}-90));
|
|
31
|
+
}`).join('\n');
|
|
32
|
+
export class SubAvatar extends SubstratElement {
|
|
33
|
+
static properties = {
|
|
34
|
+
show: { reflect: true },
|
|
35
|
+
sessionUrl: { attribute: 'session-url' },
|
|
36
|
+
size: {},
|
|
37
|
+
session: { attribute: false },
|
|
38
|
+
};
|
|
39
|
+
#session = new SessionController(this);
|
|
40
|
+
constructor() {
|
|
41
|
+
super();
|
|
42
|
+
this.show = 'avatar';
|
|
43
|
+
this.sessionUrl = '/api/me';
|
|
44
|
+
this.size = '2rem';
|
|
45
|
+
}
|
|
46
|
+
/** What is drawn: the `session` property when set, the read otherwise. */
|
|
47
|
+
get state() {
|
|
48
|
+
return this.#session.state;
|
|
49
|
+
}
|
|
50
|
+
/** Read the session again (every element on that URL redraws). */
|
|
51
|
+
refresh() {
|
|
52
|
+
return this.#session.refresh();
|
|
53
|
+
}
|
|
54
|
+
static css = css `
|
|
55
|
+
:host {
|
|
56
|
+
display: inline-flex;
|
|
57
|
+
align-items: center;
|
|
58
|
+
gap: var(--wa-space-xs);
|
|
59
|
+
font-family: var(--wa-font-family-body);
|
|
60
|
+
font-size: var(--wa-font-size-s);
|
|
61
|
+
color: var(--wa-color-text-normal);
|
|
62
|
+
vertical-align: middle;
|
|
63
|
+
min-width: 0;
|
|
64
|
+
}
|
|
65
|
+
wa-avatar {
|
|
66
|
+
flex: none;
|
|
67
|
+
font-weight: var(--wa-font-weight-semibold);
|
|
68
|
+
}
|
|
69
|
+
.placeholder {
|
|
70
|
+
flex: none;
|
|
71
|
+
border-radius: 50%;
|
|
72
|
+
background: var(--wa-color-neutral-fill-quiet);
|
|
73
|
+
}
|
|
74
|
+
.label {
|
|
75
|
+
min-width: 0;
|
|
76
|
+
overflow: hidden;
|
|
77
|
+
text-overflow: ellipsis;
|
|
78
|
+
white-space: nowrap;
|
|
79
|
+
}
|
|
80
|
+
${unsafeCSS(HUE_RULES)}
|
|
81
|
+
`;
|
|
82
|
+
render() {
|
|
83
|
+
const state = this.state;
|
|
84
|
+
const box = `--size: ${this.size}; width: ${this.size}; height: ${this.size}`;
|
|
85
|
+
if (state.phase === 'loading')
|
|
86
|
+
return html `<span class="placeholder" style=${box} aria-hidden="true"></span>`;
|
|
87
|
+
if (state.phase === 'signed-out')
|
|
88
|
+
return nothing;
|
|
89
|
+
const s = state.session;
|
|
90
|
+
const beside = this.show === 'email' ? (s.email ?? s.display) : this.show === 'name' ? s.display : '';
|
|
91
|
+
// Named when it stands alone; when the name is written beside it, the picture is
|
|
92
|
+
// decoration and the text is what is read.
|
|
93
|
+
return html `<wa-avatar
|
|
94
|
+
data-hue=${hueOf(s.principal)}
|
|
95
|
+
style=${box}
|
|
96
|
+
image=${s.picture ?? ''}
|
|
97
|
+
initials=${initialsOf(s.display)}
|
|
98
|
+
label=${beside ? '' : s.display}
|
|
99
|
+
aria-hidden=${beside ? 'true' : nothing}
|
|
100
|
+
loading="lazy"
|
|
101
|
+
></wa-avatar
|
|
102
|
+
>${beside ? html `<span class="label" part="label">${beside}</span>` : nothing}`;
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
if (!customElements.get('sub-avatar'))
|
|
106
|
+
customElements.define('sub-avatar', SubAvatar);
|
|
107
|
+
//# sourceMappingURL=avatar.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"avatar.js","sourceRoot":"","sources":["../src/avatar.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,yDAAyD,CAAC;AACjE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AACpD,OAAO,eAAe,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAmC,MAAM,cAAc,CAAC;AAIxF;;;GAGG;AACH,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CACxB,CAAC,CAAC,EAAE,EAAE,CAAC,uBAAuB,CAAC;kDACiB,CAAC,wBAAwB,CAAC;uCACrC,CAAC,wBAAwB,CAAC;IAC7D,CACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEb,MAAM,OAAO,SAAU,SAAQ,eAAe;IAC5C,MAAM,CAAC,UAAU,GAAG;QAClB,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;QACvB,UAAU,EAAE,EAAE,SAAS,EAAE,aAAa,EAAE;QACxC,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;KAC9B,CAAC;IAQO,QAAQ,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEhD;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC;IACrB,CAAC;IAED,0EAA0E;IAC1E,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED,kEAAkE;IAClE,OAAO;QACL,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,GAAG,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;MA0BZ,SAAS,CAAC,SAAS,CAAC;GACvB,CAAC;IAEF,MAAM;QACJ,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,MAAM,GAAG,GAAG,WAAW,IAAI,CAAC,IAAI,YAAY,IAAI,CAAC,IAAI,aAAa,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9E,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;YAAE,OAAO,IAAI,CAAA,mCAAmC,GAAG,6BAA6B,CAAC;QAC9G,IAAI,KAAK,CAAC,KAAK,KAAK,YAAY;YAAE,OAAO,OAAO,CAAC;QACjD,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,iFAAiF;QACjF,2CAA2C;QAC3C,OAAO,IAAI,CAAA;mBACI,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;gBACrB,GAAG;gBACH,CAAC,CAAC,OAAO,IAAI,EAAE;mBACZ,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC;gBACxB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO;sBACjB,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;;;SAGtC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA,oCAAoC,MAAM,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACpF,CAAC;CACF;AAED,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC;IAAE,cAAc,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Web Awesome controls a Substrat app may use, registered in one import.
|
|
3
|
+
*
|
|
4
|
+
* A curated set rather than all of Web Awesome: this list is the vocabulary a person or
|
|
5
|
+
* an agent writes screens in, and a short list is one nobody has to guess at. Each is
|
|
6
|
+
* from the free core. Add one here when a screen needs it, not before.
|
|
7
|
+
*/
|
|
8
|
+
import '@awesome.me/webawesome/dist/components/button/button.js';
|
|
9
|
+
import '@awesome.me/webawesome/dist/components/callout/callout.js';
|
|
10
|
+
import '@awesome.me/webawesome/dist/components/checkbox/checkbox.js';
|
|
11
|
+
import '@awesome.me/webawesome/dist/components/dropdown/dropdown.js';
|
|
12
|
+
import '@awesome.me/webawesome/dist/components/dropdown-item/dropdown-item.js';
|
|
13
|
+
import '@awesome.me/webawesome/dist/components/input/input.js';
|
|
14
|
+
import '@awesome.me/webawesome/dist/components/option/option.js';
|
|
15
|
+
import '@awesome.me/webawesome/dist/components/radio/radio.js';
|
|
16
|
+
import '@awesome.me/webawesome/dist/components/radio-group/radio-group.js';
|
|
17
|
+
import '@awesome.me/webawesome/dist/components/select/select.js';
|
|
18
|
+
import '@awesome.me/webawesome/dist/components/spinner/spinner.js';
|
|
19
|
+
import '@awesome.me/webawesome/dist/components/switch/switch.js';
|
|
20
|
+
import '@awesome.me/webawesome/dist/components/tag/tag.js';
|
|
21
|
+
//# sourceMappingURL=controls.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"controls.d.ts","sourceRoot":"","sources":["../src/controls.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,yDAAyD,CAAC;AACjE,OAAO,2DAA2D,CAAC;AACnE,OAAO,6DAA6D,CAAC;AACrE,OAAO,6DAA6D,CAAC;AACrE,OAAO,uEAAuE,CAAC;AAC/E,OAAO,uDAAuD,CAAC;AAC/D,OAAO,yDAAyD,CAAC;AACjE,OAAO,uDAAuD,CAAC;AAC/D,OAAO,mEAAmE,CAAC;AAC3E,OAAO,yDAAyD,CAAC;AACjE,OAAO,2DAA2D,CAAC;AACnE,OAAO,yDAAyD,CAAC;AACjE,OAAO,mDAAmD,CAAC"}
|
package/dist/controls.js
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Web Awesome controls a Substrat app may use, registered in one import.
|
|
3
|
+
*
|
|
4
|
+
* A curated set rather than all of Web Awesome: this list is the vocabulary a person or
|
|
5
|
+
* an agent writes screens in, and a short list is one nobody has to guess at. Each is
|
|
6
|
+
* from the free core. Add one here when a screen needs it, not before.
|
|
7
|
+
*/
|
|
8
|
+
import '@awesome.me/webawesome/dist/components/button/button.js';
|
|
9
|
+
import '@awesome.me/webawesome/dist/components/callout/callout.js';
|
|
10
|
+
import '@awesome.me/webawesome/dist/components/checkbox/checkbox.js';
|
|
11
|
+
import '@awesome.me/webawesome/dist/components/dropdown/dropdown.js';
|
|
12
|
+
import '@awesome.me/webawesome/dist/components/dropdown-item/dropdown-item.js';
|
|
13
|
+
import '@awesome.me/webawesome/dist/components/input/input.js';
|
|
14
|
+
import '@awesome.me/webawesome/dist/components/option/option.js';
|
|
15
|
+
import '@awesome.me/webawesome/dist/components/radio/radio.js';
|
|
16
|
+
import '@awesome.me/webawesome/dist/components/radio-group/radio-group.js';
|
|
17
|
+
import '@awesome.me/webawesome/dist/components/select/select.js';
|
|
18
|
+
import '@awesome.me/webawesome/dist/components/spinner/spinner.js';
|
|
19
|
+
import '@awesome.me/webawesome/dist/components/switch/switch.js';
|
|
20
|
+
import '@awesome.me/webawesome/dist/components/tag/tag.js';
|
|
21
|
+
//# sourceMappingURL=controls.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"controls.js","sourceRoot":"","sources":["../src/controls.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,yDAAyD,CAAC;AACjE,OAAO,2DAA2D,CAAC;AACnE,OAAO,6DAA6D,CAAC;AACrE,OAAO,6DAA6D,CAAC;AACrE,OAAO,uEAAuE,CAAC;AAC/E,OAAO,uDAAuD,CAAC;AAC/D,OAAO,yDAAyD,CAAC;AACjE,OAAO,uDAAuD,CAAC;AAC/D,OAAO,mEAAmE,CAAC;AAC3E,OAAO,yDAAyD,CAAC;AACjE,OAAO,2DAA2D,CAAC;AACnE,OAAO,yDAAyD,CAAC;AACjE,OAAO,mDAAmD,CAAC"}
|