You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/v2/components/header/README.md
+17-9Lines changed: 17 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
A Lit-based custom element that renders the Solid application header, including branding, auth actions, account management, and a help menu.
4
4
5
-
When `layout="mobile"`, the header hides the help menu entirely, even if `helpMenuList` items or `help-menu` slotted content are provided.
5
+
When `layout="mobile"`, the header hides the help menu entirely, even if `helpMenuList` items or `help-menu` slotted content are provided. In this mode the header also omits icons from the built-in login/sign-up buttons, hides the account webid text in the account dropdown, and hides the logout icon.
6
6
7
7
When `auth-state="logged-out"`, the header renders a `<solid-ui-login-button>` as the login action. The login button opens a Solid IDP selection popup and handles the full OIDC login flow via `solid-logic`. On success it emits a `login-success` event and the header transitions to `logged-in` state automatically.
8
8
@@ -79,17 +79,21 @@ The header automatically imports and registers it — no separate import is need
79
79
Properties/attributes:
80
80
81
81
-`logo`: URL string for the brand image (default: Solid emblem URL).
82
-
-`helpIcon`: URL string for the help icon, default from icons asset.
82
+
-`helpIcon`: URL string for the help icon, default from icons asset. If `help-icon` is empty or not provided, the help trigger renders the text `Help` instead.
83
83
-`brandLink`: URL string for the brand link (default: `#`).
84
-
-`layout`: `desktop` or `mobile`. Mobile layout hides the brand logo link and does not render the help menu.
84
+
-`layout`: `desktop` or `mobile`. Mobile layout hides the brand logo link, does not render the help menu, omits icons from the built-in login and sign-up buttons, hides the account webid text in the dropdown, and hides the logout icon.
85
85
-`theme`: `light` or `dark`.
86
86
-`authState`: `logged-out` or `logged-in`.
87
-
-`loginAction`: object with a `label` for the login button. When `authState` is `logged-out` this is rendered as a `<solid-ui-login-button>` which handles the full OIDC flow; supplying a `url` instead opts out of the built-in flow and renders a plain link.
88
-
-`signUpAction`: object for the logged-out Sign Up action. The `label` field sets the button text and the `url` field (default: `https://solidproject.org/get_a_pod`) is the destination opened in a new tab when the button is clicked.
87
+
-`loginAction`: object with a `label` for the login button. When `authState` is `logged-out` this is rendered as a `<solid-ui-login-button>` which handles the full OIDC flow; supplying a `url` instead opts out of the built-in flow and renders a plain link. The optional `icon` field supplies a left-aligned icon URL for the rendered login button, but icons are hidden on mobile layout.
88
+
-`signUpAction`: object for the logged-out Sign Up action. The `label` field sets the button text, the `url` field (default: `https://solidproject.org/get_a_pod`) is the destination opened in a new tab when the button is clicked, and the optional `icon` field supplies a left-aligned icon URL for the rendered signup button, but icons are hidden on mobile layout.
89
89
-`accountLabel`: label for the logged-in dropdown trigger (default: `Accounts`).
90
90
-`accountAvatar`: avatar URL used as the logged-in dropdown icon.
91
+
-`accountAvatarFallback`: avatar URL used when `accountAvatar` is not provided. This replaces the internal default profile placeholder image.
92
+
-`loginIcon`: optional URL string for a left-aligned icon on the login action button, taking precedence over `loginAction.icon`. Icons are still hidden on mobile layout.
93
+
-`signUpIcon`: optional URL string for a left-aligned icon on the sign-up action button, taking precedence over `signUpAction.icon`. Icons are still hidden on mobile layout.
91
94
-`accountMenu`: array of account entries for the logged-in dropdown.
92
95
-`logoutLabel`: string label for the logout button at the bottom of the logged-in dropdown (default: `Log out`). Set to `null` to hide it.
96
+
-`logoutIcon`: URL string for a left-aligned icon displayed in the logout menu item. Hidden on mobile layout.
93
97
94
98
Slots:
95
99
@@ -115,10 +119,14 @@ Use `auth-state="logged-out"` to render the `<solid-ui-login-button>` and a Sign
0 commit comments