Static ReadonlyCHOICE_Static ReadonlyCHOOSER_Static ReadonlyCLIP_How much of a long value clipped() draws before the full text is
behind a hover.
Static ReadonlyDEFAULT_Static ReadonlyFIND_Static ReadonlyLIST_Static ReadonlyMAX_Static ReadonlyONE_About one rendered line of .note text: past this a note is folded.
Static ReadonlySUMMARY_The longest summary a fold may carry.
Static ReadonlyTIP_The longest tooltip tip() writes by default.
Staticbase64Encodes a string's UTF-8 bytes as base64.
the string
the base64, padded
StaticbulletDraws one item of a prose list, folded when longer than a line.
An item opening with a link is never folded; one opening with <code>
keeps it in the summary.
the item as HTML
Optionallabel: any
optional; a summary, which also forces the fold
the <li> as HTML
StaticcheckThe check mark a value seen in use carries (#706), inline for the trash icon's reason.
the SVG as HTML
StaticchoiceThe label a choice is drawn with: a URN's last two sections, any other value as it is.
the value
the label
StaticchoiceThe tooltip a choice carries: its full value where the label shortens it, and what it means where CHOICE_NOTES knows.
the attribute
the value
the page's translator (#539)
the tooltip text, or '' for none
StaticchooserAnswers whether any of an entry's names contains what was typed.
every spelling of the entry
what was typed; '' matches everything
true when it matches
StaticchooserDraws a search box and a paged, scrolling pane of matching entries, shared by every chooser on the console.
The form submits back to the page it is drawn on, carrying the rest of the query, with a fragment that returns the reader to the pane; a stale offset is clamped to the first page.
here, param, fromParam, label, placeholder, entries, selectedKey and nothing, as the comment above describes
optional; the translator (#539), the default when left out
the form, the pane and its paging note as HTML
StaticclippedDraws a value clipped to a limit, with the whole of it on focus.
A value over the limit gets a hover/focus panel holding the full text.
the value to draw; a dash when null or empty
the character limit (CLIP_CHARS when not given)
optional; the translator (#539), the default when left out
the clipped value as HTML
StaticclippedDraws an attribute's values, each clipped, one per line.
one value or an array of them
Optionalkeep: any
optional; the character limit passed to clipped()
optional; the translator (#539), the default when left out
the values as one inline-block column of HTML
StaticcodeDraws a list of names, each in its own <code>, joined with commas.
the names to draw
the list as HTML
StaticcontextBuilds the render context a page's renderer takes beside its view.
Optionalquery: any
the page's query parameters, by name
Optionalwrite: any
whether the reader may write
Optionalt: any
the page's translator (#539 phase 5): the runtime's, built
from GET /admin-api/console's locale; without one, the default
(English in node, set by common/i18n.ts; key-drawing in a browser)
Optionalsecurity: any
whether the reader holds the Security Administrator's role (#645), which a policy page asks before it offers a Save
{ query, write, security, t }, the query copied and the two
flags booleans
StaticcopyDraws a hidden Copy button for a value, which /admin/copy.js reveals.
the text the button copies
optional; the translator (#539), the default when left out
the markup
StaticdelegatedThe key a list value a delegated permission grant declares carries (#1141), inline for the trash icon's reason.
the SVG as HTML
StaticderivedThe values a delegated permission grant declares in a list cell (#1141): read-only, each with the key, its details as a tooltip, and a link to the Permissions tab where the delegated permission grant is changed. None is an input, so a save neither posts nor stores them.
{ value, permission, api, apiName } each
the page's translator (#539)
the entries as HTML, or '' for none
StaticdrawsStaticdrillDraws a drill-down's head: a back link to the tab it was opened from, then its title with a note beside it.
the title, as HTML
beside the title (such as the route's path), as HTML; '' for none
the parent tab's address, page and fragment
the back link's text, as HTML
the heading row as HTML
StaticdurationFormats a duration as days, hours, minutes and seconds.
the duration in milliseconds
the text, such as 1d 2h 3m 4s
StaticescEscapes a value for HTML, drawing null and undefined as empty.
the value to escape
the escaped text, with an apostrophe as '
StaticfamilyReturns the CSS classes that show a block only while one of its families is ticked.
the family ids the block serves
pf pf-<id> ..., or an empty string for an unconditional block
StaticfieldDraws one field of the grid: its name (with its sentence as a tooltip), the families it belongs to, and the control its type needs.
the field's row, typed by gridFieldTyped()
the grid's values by attribute
redraw (the route "+" and delete post to), showSet
(show a cell holding a value whatever is ticked), generateSecret,
secretLifetime (HTML drawn after Generate Secret, #394),
and protocols, the families a cell's labels are named from;
views (#500), the cell is classed fg-adv unless row.simple, so
its form's simple / advanced switch (viewSwitch()) can hide it;
derived (#1141), the read-only values a list holds without storing
them, by attribute (derivedListItems())
optional; the translator (#539), the default when left out
the cell as HTML
StaticfieldDraws a field grid: each group's cells under its heading.
the rows, typed for their controls
the field groups, in drawing order (id, label)
the grid's values by attribute
fieldGridCell()'s options, protocols among them
optional; the translator (#539), the default when left out
the grid as HTML
StaticfieldDraws a list field's search: the box, Find, and the page of results.
the list's attribute
applications, groups or parties (people or
applications, one value), what the search finds
the last search's results for this list, or nothing
the route the grid's round trips post to
optional; the translator (#539), the default when left out
the search as HTML
StaticfilterReturns a list view without its page and per parameters.
the list view's parameters
a new object holding every other parameter
StaticflashWraps the messages a pressed button came back with in the strip that stays at the top of the window, so they are seen wherever the page lands.
the messages as HTML
the strip, or '' for no messages
StaticfoldSplits a note into the summary and the body of a fold.
the note as HTML
a summary to use instead of the derived one, or nothing
the summary and body, both as HTML
StaticframeDraws a block inside a section frame.
the block as HTML, its heading first
the framed block, or '' for an empty one
StaticgridReads the grid's values out of a posted form, keeping every list box — an empty one included — in box order, and applies a "+" or a delete.
the posted form
OptionallongText: any
optional; the attributes one box holds whole
(applications.LONG_TEXT_ATTRIBUTES)
the values by attribute
StatichasWhether a sub-tab's fields earn a simple / advanced switch: six or more, some shown by the simple view and some not.
the fields the sub-tab draws, each with simple
true when the switch is drawn
StatichumanWords a number of seconds as a person reads it: exact below a minute, to one decimal place in minutes, hours or days above.
the number of seconds
optional; the translator (#539), the default when left out
the phrase, or "no allowance at all" for zero
StatickindDraws an application's kinds as one cell, one per line, or unstated.
the kinds to draw
the cell's HTML
StaticlanguageDraws the console's language chooser.
the page's translator
GET /admin-api/console's locale member
the chooser as HTML, or '' when nothing is offered
StaticlistRebuilds a list view from a form's back query string.
It is rebuilt through listViewOf() and never echoed, so it cannot carry an open redirect or a header injection.
the list page's path
the back field's value
the list view; empty when the field cannot be parsed
StaticlistPicks a list page's filter and page parameters out of a query.
Only the keys LIST_PARAMS names for the section are kept; the first of a repeated parameter wins.
the list page's path
the request's query object
the list view, as parameter names to strings
StaticmailDraws the ticked "mail it to them" checkbox (deliver=mail) for a
link, or a note that the realm has no mail transport.
what is mailed, as the sentence names it
Optionalavailable: any
optional; whether the realm has a mail transport
optional; the translator (#539), the default when left out
the box or the note as HTML
StaticmetadataDraws a block inside a section frame that the tab splitter keeps on Metadata.
the block as HTML, its heading first
the framed block, or '' for an empty one
StaticnoteDraws a paragraph of explanation, folded when longer than a line.
the paragraph as HTML
Optionallabel: any
optional; a summary, which also forces the fold
the note as HTML
StaticpageBuilds the paging control for one list, as a head and a foot copy.
Only the head copy carries the id its links' fragment names; both are empty when the list fits on one page.
the page the links point at
the page parameters every link carries
the list's paging object from pagingOf()
optional; the translator (#539), the default when left out
an object whose head and foot are each the control as HTML
StaticpageReturns a query's view parameters, first value each, without format,
notice and error.
the query
the parameters
StaticpanelsStaticperDraws a stand-alone rows-per-table form for a drill-down page.
Submitting it resets every table's page to the first.
the page the form submits to
the name of the hidden parameter that selects the drill-down, or '' for a list with no drill-down to select
that parameter's value
the page size in use
OptionalextraNote: any
optional; a sentence added to the form's note
Optionalcarry: any
optional; the list filter to carry as hidden inputs
optional; the translator (#539), the default when left out
the form as HTML
StaticperDraws the options of the rows-per-page select.
A size that is not one of the offered choices is added to the list.
the page size in use, which is marked selected
optional; the translator (#539), the default when left out
the
StaticplainReturns a fragment's visible text: tags removed, whitespace collapsed.
Entities are left as they were, so the result is still valid HTML text.
an HTML fragment
the text
StaticqueryReturns one query parameter's first value as text.
the query
the parameter's name
the value, or '' when absent
StaticqueryBuilds a query string from page parameters, with some overridden; an empty, null or undefined value is left out.
the parameters to carry
the parameters to set or clear
the query string with its ?, or '' when nothing is left
StaticrefusalDraws a refusal in the floating banner, the shape the application pages use: a heading and the reasons as a list (#1066).
the reasons, in the server's words
Optionaltitle: any
optional; the heading, English as every refusal is (#539)
the banner as HTML, or '' when there is no reason
StaticsectionDraws a one-box search form over one section of a multi-table page.
The form submits to a fragment naming itself, carries every other page parameter, and drops the search term and the section's page number.
the path, query, param, pageParam, label, placeholder and what of the search
optional; the translator (#539), the default when left out
the form, and the optional note under it, as HTML
StaticsentenceFinds where the opening sentence ends, as an offset into the markup.
Only at element depth zero and at least thirty characters in.
an HTML fragment
the offset after the sentence's stop, or -1
StaticshortenedDraws a long opaque value shortened, with the whole value in the title.
the value to draw; a dash when empty
how many characters to keep (18 when not given)
a element as HTML
StaticspanFormats a duration in at most two units, such as "4 min 12 s".
the duration in milliseconds
the text
StaticsubDraws panels as sub-tabs: a bar of links, then each panel with something
in it, the first shown when no fragment picks one. tabbedPanels()'s
mechanism one level down.
what the bar is, for a screen reader
{ id, label, html } in tab order; href as
tabbedPanels() takes it
the sub-tabs as HTML
StatictabbedDraws panels as tabs: a bar of links, then each panel with something in it, the first shown when no fragment picks one.
an extra class for the container
{ id, label, html } in tab order; optionally href
(the tab is a link there; with no html, no panel is drawn)
the tabs as HTML
StatictabStaticteaserCuts text to a summary line at a word boundary, ending in an ellipsis.
the text
Optionalmax: any
optional; the length, SUMMARY_CHARS by default
the text, cut if it was longer
StatictileDraws one statistics tile.
the number
what it counts
the tile as HTML
StatictipBuilds a title attribute, with its leading space, from prose.
the prose, as markup or plain text
Optionalmax: any
optional; the length, TIP_CHARS by default; Infinity
keeps the whole text
the attribute; empty when there is no text
StatictrashThe trash-can icon a list box's delete button carries, inline so the console still makes no image request.
the SVG as HTML
StaticunescapeResolves the entities a title attribute cannot show.
the text
the text with those entities resolved, & last
StaticuntitledA section's markup without its own heading, any further <h2> drawn
as an <h3>.
the section, its heading first
the section's body
StaticviewDraws a sub-tab form's simple / advanced switch.
what the switch is for, for its group's name
true to draw it on the advanced view
how many fields the simplified view hides
how many of those hold a value
optional; the translator (#539), the default when left out
the switch as HTML
StaticvisibleMeasures how long text reads, counting each entity as one character.
plainTextOf()'s output
the length
StaticwarnDraws a warning box, folded when longer than a line.
the warning as HTML
Optionallabel: any
optional; a summary, which also forces the fold
the warning as HTML
StaticwarnThe warning mark a value seen but not declared carries (#708), inline for the trash icon's reason.
the SVG as HTML
StaticwhenFormats an instant as a UTC date and time without milliseconds.
milliseconds since the epoch
the text; a dash when there is none
StaticwideWraps a wide table in a focusable box that scrolls sideways.
the region's accessible name
the whole table as HTML
the wrapped table as HTML
StaticwithA panel's markup with its documentation link, unless it is a tab container.
{ id, html, docs? }
the panel body
The console's rendering kit: escaping, the statistics tile, and the prose helpers that fold a paragraph longer than a line. Loadable in a browser; it requires nothing.
A static utility class; it holds no state and takes no dependencies.