I'm not really sure of a good way to implement this, but when the
component prop is provided, all valid props from that component should
also be allowed.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optional aria-atomic
aria-atomic?:Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
presented if they are made.
Optional aria-busy
aria-busy?:Booleanish
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
Indicates what functions can be performed when a dragged object is released on the drop target.
deprecated
in ARIA 1.1
Optional aria-errormessage
aria-errormessage?:string
Identifies the element that provides an error message for the object.
see
aria-invalid @see aria-describedby.
Optional aria-expanded
aria-expanded?:Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optional aria-flowto
aria-flowto?:string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
allows assistive technology to override the general default of reading in document source order.
Optional aria-grabbed
aria-grabbed?:Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the entered value does not conform to the format expected by the application.
see
aria-errormessage.
Optional aria-keyshortcuts
aria-keyshortcuts?:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optional aria-label
aria-label?:string
Defines a string value that labels the current element.
see
aria-labelledby.
Optional aria-labelledby
aria-labelledby?:string
Identifies the element (or elements) that labels the current element.
see
aria-describedby.
Optional aria-level
aria-level?:number
Defines the hierarchical level of an element within a structure.
Optional aria-live
aria-live?:"off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Optional aria-modal
aria-modal?:Booleanish
Indicates whether an element is modal when displayed.
Optional aria-multiline
aria-multiline?:Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Optional aria-multiselectable
aria-multiselectable?:Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Optional aria-orientation
aria-orientation?:"horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optional aria-owns
aria-owns?:string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
see
aria-controls.
Optional aria-placeholder
aria-placeholder?:string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
A hint could be a sample value or a brief description of the expected format.
Optional aria-posinset
aria-posinset?:number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
Indicates if items in a table or grid are sorted in ascending or descending order.
Optional aria-valuemax
aria-valuemax?:number
Defines the maximum allowed value for a range widget.
Optional aria-valuemin
aria-valuemin?:number
Defines the minimum allowed value for a range widget.
Optional aria-valuenow
aria-valuenow?:number
Defines the current value for a range widget.
see
aria-valuetext.
Optional aria-valuetext
aria-valuetext?:string
Defines the human readable text alternative of aria-valuenow for a range widget.
Optional autoCapitalize
autoCapitalize?:string
Optional autoCorrect
autoCorrect?:string
Optional autoSave
autoSave?:string
Optional children
children?:ReactNode
Optional className
className?:string
Optional color
color?:string
component
component:ElementType<any>
An optional component to render as. This should really only be used if you
are using a router library like
react-router or
@reach/router. This will call
createElement with this value and provide all props and class name.
Optional contentEditable
contentEditable?:Booleanish | "inherit"
Optional contextMenu
contextMenu?:string
Optional dangerouslySetInnerHTML
dangerouslySetInnerHTML?:{ __html: string }
Type declaration
__html: string
Optional datatype
datatype?:string
Optional defaultChecked
defaultChecked?:boolean
Optional defaultValue
defaultValue?:string | number | readonly string[]
Optional dir
dir?:string
Optional download
download?:any
Optional draggable
draggable?:Booleanish
Optional flexCentered
flexCentered?:boolean
Boolean if the Link should be positioned with a flexbox and align the items
centered. This is disabled by default but can be useful when rendering
icons within the link.
Optional hidden
hidden?:boolean
Optional href
href?:string
An optional href to apply to the link. If this value is set to the empty
string and the component prop is not provided, the link will basically be
disabled.
Boolean if the link should automatically be updated to apply
rel=noopener noreferrer when the target prop is set to "_blank". This
is recommended to have enabled by default, but can be disabled by setting
this prop to false or specifying a rel prop yourself. You can read
more about the reason for this
here.
Optional property
property?:string
Optional radioGroup
radioGroup?:string
Optional referrerPolicy
referrerPolicy?:HTMLAttributeReferrerPolicy
Optional rel
rel?:string
An optional rel to apply to the link. This should be a combination of 1
to many of:
"alternate"
"author"
"bookmark"
"external"
"help"
"license"
"next"
"nofollow"
"noreferrer"
"noopener"
"prev"
"search"
"tag"
This is really just used to override the default behavior of the
preventMaliciousTarget prop.
Optional resource
resource?:string
Optional results
results?:number
Optional role
role?:AriaRole
Optional security
security?:string
Optional slot
slot?:string
Optional spellCheck
spellCheck?:Booleanish
Optional style
style?:CSSProperties
Optional suppressContentEditableWarning
suppressContentEditableWarning?:boolean
Optional suppressHydrationWarning
suppressHydrationWarning?:boolean
Optional tabIndex
tabIndex?:number
Optional target
target?:string
An optional target for the link to be opened in. It is recommended to keep
this undefined in most cases. If this is not _blank, _parent, _self,
or _top, it should be the frame name that the link should be rendered in
if using frames.
I'm not really sure of a good way to implement this, but when the
component
prop is provided, all valid props from that component should also be allowed.