Package-level declarations

Predefined constants for all ARIA attributes

This hook encapsulates the generation of some ARIA-attribute, that deals with referencing some other tag by id.

This Hook encapsulates the effect of setting an attribute to a Tag.

This Hook encapsulates the effect of setting a boolean attribute to a Tag.

This property keeps track of the external data binding of some component.

Expressive model for any Direction with usable value for index manipulation:

This alias should express the main concept of a Hook: The encapsulated effect; that is applying some function with a payload P onto a receiver C (often some Tag). Optionally you can pass in an also-expression that is called on the Result R.

A Hook is a special kind of Property that encapsulates an Effect as the Property's value.

This type is used to decide which strategy for setting an initial focus is appropriate for trapFocusInMountpoint function.

Base class that provides all functionality needed for components, that have some "open" and "close" state of representation.

Expressive model for the orientation of some (UI) element.

Base class that provides the functionality to create popup components.

Enum-Class to set the width of the Popup to Min: Minimum the width of the reference Max: Maximum the width of the reference Exact: Exactly the width of the reference

This class implements the concept of some data holder, that can be configured after construction by some client code. A property is usually used within some kind of component, which needs to hold some specific data portion in order to work, but to delegate the setup of the data to the client code.

Alias in order to reduce boilerplate code for the awkward signature of a Tag-factory of RenderContext.

This hook abstraction simplifies a Tag creating Hook by offering static invoke methods, which already deal with constructing the value field, so that an abstract renderTag method is called. This covers the typical use case where a client only wants to configure exactly one value (flow or static) and the hook should use this to render some artifact.

This specialized payload alias should express the common needed parameters when the Effect render some Tag, so it uses a Triple to group a String for the classes, a String for the Tag's id and the unspecific payload P itself.

This key is used to enable helpful information about the structure of headless components within the final HTML representation.

This function will add the name of the corresponding component factory or brick into the DOM as comment node.

Sets an attribute only if it is not present yet.

This hook method applies a Hook's encapsulated behaviour to the calling context.

This hook method applies multiple Hook's encapsulated behaviour to the calling context with the payload of type Unit.

This hook method applies a Hook's encapsulated behaviour to the calling context and passes a given payload.

This hook method applies a Hook's encapsulated behaviour to the calling context with a specific payload TagPayload, which is tailored to Tag creation, as it offers parameters for the id and a styling parameter classes on top to the generic payload P.

With Portalling a rendered overlay will be rendered outside of the clipping ancestors to avoid clipping. Therefore, a portalRoot is needed as last element in the document.body.

A portalRoot is needed to use floating components like dev.fritz2.headless.components.modal, dev.fritz2.headless.components.toast and dev.fritz2.headless.components.popOver. Basically all components based upon PopUpPanel.

Implements a forward cycling through a List instance.

Implements a backwards cycling through a List instance.

Sets focus on the Tag it is called on. Continues to try setting the focus until it was successful or the maximum number of retries is reached. Use this function for example to set the focus on an element that just becomes visible.

Mark some Tag with a data-attribute INITIAL_FOCUS_DATA_ATTR so that the trapFocusInMountpoint function can find this Tag and set the initial focus to it.

Mark some Tag with a data-attribute INITIAL_FOCUS_DATA_ATTR so that the trapFocusInMountpoint function can find this Tag and set the initial focus to it.

This function enables a so called focus-trap. This enforces the specific behaviour within the receiver Tag, that switching the focus is only possible on elements that are inside the receiver. No other focusable elements outside the enclosing container will get the focus.

This variant of trapFocusInMountpoint allows to reactively trap a focus based on a conditional Flow of Boolean. This should be applied in all situations, where the DOM subtree of the trap is not inside a mount-point, but only activated or disabled by some Flow.