Module: /ui/locations/entries/link

ui/locations/entries/link

The link entry module exports the default link_entry method to create link elements for the location view.

Source: ui/locations/entries/link.mjs, line 1

Methods

(inner) link_entry(entry) → {HTMLElement}

This entry function returns an HTML element with a hyperlink to open in a new window. The link is labelled with configurable text and a material symbol for readability.

This element supports report object configuration with a custom template and optional url parameters.

Styling options include altering icon name and its css class and also a placeholder for including other existing css classes on the element itself.

Parameters:

Name	Type	Description
`entry`	infoj-entry	type:link entry.

Properties

Name Type Attributes Description

entry.url

object

Target link, required.

entry.params

object

Optional parameters to include in the url as encoded query string.

entry.report

object

Optional report configuration if the link corresponds to a report. Using report requires template property with optional label.

Properties

Name	Type	Attributes	Description
`template`	string	<optional>	Identifier for the document to display under the report link, required.
`label`	string	<optional>	Optional custom label for the report link.

entry.label

string

Text to display, defaults to generic link text.

entry.data_id

string

Optional data_id for element identification.

entry.link_class

string

Optional classList string applied to the link element, eg. outlined.

entry.icon_class

string

Optional classList string appended to the material-symbols-outlined class for the icon element.

entry.icon_name

string

Optional icon name from Material Icons https://fonts.google.com/icons. Defaults to open_in_new and sets to description for reports.

Source: ui/locations/entries/link.mjs, line 9

Returns:

tag with inline content.

Type:: HTMLElement