Skip to main content
Light Dark System

Ai

<et2-ai> | Et2Ai
Since 23.1

AI Assistant widget to process content of slotted elements

The widget provides an interface to an AI assistant that can process the content of its slotted element. It presents a dropdown menu with various prompts (e.g., summarize, fix grammar) and displays the result in a card for review before applying it back to the target widget.

Examples

Single Target (Default)

By default, the widget processes the first element placed in its default slot.

<et2-ai>
<et2-textbox value="This is some text that needs to be more formal."></et2-textbox>
</et2-ai>

Multiple Elements (Nested Target)

If you want to process multiple fields together, or if your target is inside a container like Et2Box, the widget will attempt to extract values from the container using standard eTemplate2 methods.

<et2-ai>
    <et2-vbox>
        <et2-textbox label="Job" id="job_name" value="Do the thing with the thing"></et2-textbox>
        <et2-textarea label="Details" id="body" value="Don't forget the meeting tomorrow at 10 AM."></et2-textarea>
    </et2-box>
</et2-ai>

Custom Prompts

You can provide your own set of prompts. Prompts can define a target (where the result goes) and a mode (replace, append, or prepend).

<et2-ai id="custom-ai">
<et2-textarea id="my-target" value="Original content. "></et2-textarea>
</et2-ai>
<script>
    const aiWidget = document.getElementById('custom-ai');
    aiWidget.prompts = [
        {
            id: "aiassist.translate-de", 
            label: "Translate to German",
            action: { target: "#my-target", mode: "replace" }
        },
        {
            id: "custom.expand", 
            label: "Add more detail",
            action: { target: "#my-target", mode: "append" }
        }
    ];
</script>

Using Events to Interfere

You can listen for the et2-ai-apply event to modify the result before it is written to the target, or call preventDefault() to cancel the automatic application entirely.

<et2-ai id="event-demo">
    <et2-textarea value="This text will be intercepted."></et2-textarea>
</et2-ai>

<script>
    const eventAi = document.getElementById('event-demo');
    eventAi.addEventListener('et2-ai-apply', (e) => {
        // e.detail.result contains the AI output
        // e.detail.target contains the element where it will be applied
        
        if (confirm("Do you want to add a signature to the result?")) {
            e.detail.result += "\n\nGenerated by AI Assistant";
        }
        
        // To stop the widget from automatically updating the target:
        // e.preventDefault();
    });
</script>

Slots

Name Description
(default) The default slot where the target widget (e.g. et2-textarea, et2-vbox, iframe) is placed.
trigger Custom trigger element for the AI menu. Defaults to an AI assistant icon button.

Learn more about using slots.

Properties

Name Description Reflects Type Default
accesskey Accesskey provides a hint for generating a keyboard shortcut for the current element. The attribute value must consist of a single printable character. string -
actions Set Actions on the widget Each action is defined as an object: move: { type: “drop”, acceptedTypes: “mail”, icon: “move”, caption: “Move to” onExecute: javascript:mail_move” } This will turn the widget into a drop target for “mail” drag types. When “mail” drag types are dropped, the global function mail_move(egwAction action, egwActionObject sender) will be called. The ID of the dragged “mail” will be in sender.id, some information about the sender will be in sender.context. The etemplate2 widget involved can typically be found in action.parent.data.widget, so your handler can operate in the widget context easily. The location varies depending on your action though. It might be action.parent.parent.data.widget To customise how the actions are handled for a particular widget, override _link_actions(). It handles the more widget-specific parts. object -
align Used by Et2Box to determine alignment. Allowed values are left, right string -
class CSS Class. This class is applied to the outside, on the web component itself. Due to how WebComponents work, this might not change anything inside the component. string -
data Set the dataset from a CSV string -
deferredProperties
Any attribute that refers to row content cannot be resolved immediately, but some like booleans cannot stay a string because it’s a boolean attribute. We store them for later, and parse when they’re fully in their row. If you are creating a widget that can go in a nextmatch row, and it has boolean attributes that can change for each row, add those attributes into deferredProperties - -
disabled Defines whether this widget is visibly disabled. The widget is still visible, but clearly cannot be interacted with. Widgets disabled in the template will not return a value to the application code, even if re-enabled via javascript before submitting. To allow a disabled widget to be re-enabled and return a value, disable via javascript in the app’s et2_ready() instead of an attribute in the template file. boolean false
dom_id
Get the actual DOM ID, which has been prefixed to make sure it’s unique. string -
hidden The widget is not visible. As far as the user is concerned, the widget does not exist. Widgets hidden with an attribute in the template may not be created in the DOM, and will not return a value. Widgets can be hidden after creation, and they may return a value if hidden this way. boolean -
id
Get the ID of the widget string -
label The label of the widget This is usually displayed in some way. It’s also important for accessability. This is defined in the parent somewhere, and re-defining it causes labels to disappear string -
noLang Disable any translations for the widget boolean -
parentId Parent is different than what is specified in the template / hierarchy. Widget ID of another node to insert this node into instead of the normal location string -
statustext Tooltip which is shown for this element on hover string -
styles
WebComponent * - -
options
Get property-values as object
use widget methods
object -
supportedWidgetClasses
et2_widget compatability
Legacy compatability. Some legacy widgets check their parent to see whats allowed
array []
updateComplete A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Events

Name React Event Description Event Detail
et2-ai-start Emitted when an AI process begins. CustomEvent
et2-ai-success Emitted when the AI process completes successfully. CustomEvent
et2-ai-error Emitted when the AI process fails. CustomEvent
et2-ai-stop EVENT NEEDS A DESCRIPTION CustomEvent
et2-ai-apply Emitted when the user clicks ‘Apply’ to insert the result into the target. -

Learn more about events.

Methods

Name Description Arguments
checkCreateNamespace() Checks whether a namespace exists for this element in the content array. If yes, an own perspective of the content array is created. If not, the parent content manager is used. Constructor attributes are passed in case a child needs to make decisions -
clone() Creates a copy of this widget. _parent: et2_widget
createElementFromNode() Create a et2_widget from an XML node. First the type and attributes are read from the node. Then the readonly & modifications arrays are checked for changes specific to the loaded data. Then the appropriate constructor is called. After the constructor returns, the widget has a chance to further initialize itself from the XML node when the widget’s loadFromXML() method is called with the node. _node: , _name:
getArrayMgr() Returns the array manager object for the given part managed_array_type: string
getArrayMgrs() Returns an associative array containing the top-most array managers. _mgrs: object
getChildren() Get child widgets Use .children to get web component children -
getInstanceManager() Returns the instance manager -
getPath() Returns the path into the data array. By default, array manager takes care of this, but some extensions need to override this -
getRoot() Returns the base widget Usually this is the same as getInstanceManager().widgetContainer -
handlePromptSelect() User chose a prompt from the list event: CustomEvent
loadFromXML() Loads the widget tree from an XML node _node:
loadingFinished() Needed for legacy compatability. promises: Promise[]
parseXMLAttrs() The parseXMLAttrs function takes an XML DOM attributes object and adds the given attributes to the _target associative array. This function also parses the legacyOptions. N.B. This is only used for legacy widgets. WebComponents use transformAttributes() and do their own handling of attributes. _attrsObj: , _target: object, _proto: et2_widget
set_label() NOT the setter, since we cannot add to the DOM before connectedCallback() TODO: This is not best practice. Should just set property, DOM modification should be done in render https://lit-element.polymer-project.org/guide/templates#design-a-performant-template value: string
setArrayMgr() Sets the array manager for the given part _part: string, _mgr: object
setArrayMgrs() Sets all array manager objects - this function can be used to set the root array managers of the container object. _mgrs: object
setInstanceManager() Set the instance manager Normally this is not needed as it’s set on the top-level container, and we just return that reference manager: etemplate2
_errorTemplate() Template for the error state -
_findApplyTarget() Figure out the target prompt: AiPrompt
_findSemanticTarget() Try to figure out what the prompt target keywords are referring to type: string
_findSlottedTarget() Find the target if it’s the slotted child -
_get_action_links() Get all action-links / id’s of 1.-level actions from a given action object This can be overwritten to not allow all actions, by not returning them here. actions:
_getOriginalValue() Figure out the value to give for the purpose of prompting -
_handleClick() Click handler calling custom handler set via onclick attribute to this.onclick _ev: MouseEvent
_isHtmlContent() Figure out if the response is plain text or has more value: string
_link_actions() Link the actions to the DOM nodes / widget bits. actions: object
_loadingTemplate() Template for the loading state -
_renderStatus() Render the different helpers based on status -
_resultTemplate() Template for the success state -
_set_label() Do some fancy stuff on the label, splitting it up if there’s a %s in it Normally called from updated(), the “normal” setter stuff has already been run before this is called. We only override our special cases (%s) because the normal label has been set by the parent value: string
destroy() et2_widget compatability
true
-
set_class() Set the widget class
Use this.class or this.classList instead
new_class: string
set_disabled() Wrapper on this.disabled because legacy had it.
Use widget.disabled for visually disabled, widget.hidden for visually hidden. Disabled vs Readonly vs Hidden
value: boolean
set_statustext() supports legacy set_statustext
use this.statustext
value: string

Learn more about methods.

Custom Properties

Name Description Default
--max-result-height Automatically calculated based on the slotted element’s height to ensure the result card fits.

Learn more about customizing CSS custom properties.

Parts

Name Description
base The component’s internal wrapper.
result The sl-card containing the AI result or loader.
loader Specific part for the result card when in loading state.
spinner The loading spinner.
result-content The container for the returned AI text/HTML.
apply-button The button used to apply the result.
dropdown The Shoelace dropdown containing prompts.
menu The menu inside the dropdown.
menu-item Individual prompt items in the menu.
error The sl-alert shown on failure.

Learn more about customizing CSS parts.