For AI agents: the complete documentation index is at llms.txt. Remove the trailing slash from a page URL and append .md to read its Markdown version. For the docs home, use index.md.

HTML Text Elements

Text-level HTML elements are available through the rx.el namespace.

API Reference

Shared HTML props

Components linked to this section accept these HTML props. Component-specific additions and overrides are listed below.

Props

PropTypeDescription
access_key
str

Provides a hint for generating a keyboard shortcut for the current element.

auto_capitalize
"off""none""on""sentences""words""characters"

Controls whether and how text input is automatically capitalized as it is entered/edited by the user.

content_editable
"inherit""plaintext-only"

Indicates whether the element's content is editable.

context_menu
str

Defines the ID of a <menu> element which will serve as the element's context menu.

dir
str

Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left).

draggable
bool

Defines whether the element can be dragged.

enter_key_hint
"enter""done""go""next""previous""search""send"

Hints what media types the media element is able to play.

hidden
bool

Defines whether the element is hidden.

input_mode
"none""text""tel""url""email""numeric""decimal""search"

Defines the type of the element.

item_prop
str

Defines the name of the element for metadata purposes.

lang
str

Defines the language used in the element.

role
"alert""alertdialog""application""article""banner""button""cell""checkbox""columnheader""combobox""complementary""contentinfo""definition""dialog""directory""document""feed""figure""form""grid""gridcell""group""heading""img""link""list""listbox""listitem""log""main""marquee""math""menu""menubar""menuitem""menuitemcheckbox""menuitemradio""navigation""none""note""option""presentation""progressbar""radio""radiogroup""region""row""rowgroup""rowheader""scrollbar""search""searchbox""separator""slider""spinbutton""status""switch""tab""table""tablist""tabpanel""term""textbox""timer""toolbar""tooltip""tree""treegrid""treeitem"

Defines the role of the element.

slot
str

Assigns a slot in a shadow DOM shadow tree to an element.

spell_check
bool

Defines whether the element may be checked for spelling errors.

tab_index
int

Defines the position of the current element in the tabbing order.

title
str

Defines a tooltip for the element.

rx.el.abbr

Display the abbr element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.b

Display the b element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.bdi

Display the bdi element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.bdo

Display the bdo element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.br

Display the br element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.cite

Display the cite element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.code

Display the code element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.data

Display the data element.

Props

PropTypeDescription
value
Union[str, int, float]

Specifies the machine-readable translation of the data element.

Also accepts the shared HTML props.

rx.el.dfn

Display the dfn element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.em

Display the em element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.i

Display the i element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.kbd

Display the kbd element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.mark

Display the mark element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.q

Display the q element.

Props

PropTypeDescription
cite
str

Specifies the source URL of the quote.

Also accepts the shared HTML props.

rx.el.rp

Display the rp element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.rt

Display the rt element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.ruby

Display the ruby element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.s

Display the s element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.samp

Display the samp element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.small

Display the small element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.strong

Display the strong element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.sub

Display the sub element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.sup

Display the sup element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.time

Display the time element.

Props

PropTypeDescription
date_time
str

Specifies the date and/or time of the element.

Also accepts the shared HTML props.

rx.el.u

Display the u element.

Props

No component specific props

Also accepts the shared HTML props.

rx.el.wbr

Display the wbr element.

Props

No component specific props

Also accepts the shared HTML props.