Functions

Abbreviation(props)

Alias for the abbr tag. The Abbreviation element defines an abbreviation or acronym.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Address(props)

Alias for the address tag. The Address tag defines the contact information for the owner of a document or article. If contained within it will denote the contact information for the document. If contained within it will denote the contact information for that article.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Anchor(props)

Alias for the a tag. The Anchor tag defines a hyperlink which is used to link one web page to another. If using a click event to perform an action, instead of using Anchor try using Button.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Area(props)

Alias for the area tag. The Area tag defines a clickable area within an image map. Parent should be the Map component.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Article(props)

Alias for the article tag. The Article tag is used to define independent content which could be distributed separate from the parent document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Aside(props)

Alias for the aside tag. The Aside tag defines content which is an aside from the content it is placed within. The Aside tag should be relevant to the surrounding content.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Audio(props)

Alias for the audio tag. The Audio tag defines playable audio content.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Block(props)

Alias for the div tag. The Block component defines generic, non-semantic block-level content.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

BlockQuote(props)

Alias for the blockquote tag. The BlockQuote tag defines content which is quoted from another source.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Body(props)

Alias for the body tag. The Body component defines the wraps the visible document content.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Button(props)

Alias for the button tag. The Button should be used when performing a user action such as a form submission or popping a dialog.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

ButtonInput(props)

Alias for the input type="button" tag. Should be used when adding a button to a form. Though, Button will perform the same action when included in a Form by default.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Canvas(props)

Alias for the canvas tag. The Canvas tag is used to draw objects through scripting.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

CheckBox(props)

Alias for the input type="checkbox" tag. Should be used when adding a checkbox to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Cite(props)

Alias for the cite tag. The Cite tag defines the title of a work.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Code(props)

Alias for the code tag. The Code tag defines a piece of computer code.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

ColorInput(props)

Alias for the input type="color" tag. Should be used when adding a color field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

ContextMenu(props)

Alias for the menu tag. The ContextMenu defines a list or menu of commands. It can be used for context menus, toolbars, or form controls.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

ContextMenuItem(props)

Alias for the menuitem tag. The ContextMenuItem defines an element of a ContextMenu.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

DataList(props)

Alias for the datalist tag. The DataList can contain a number of pre-defined values for an Input element.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

DateInput(props)

Alias for the input type="date" tag. Should be used when adding a date field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

DescriptionDefinition(props)

Alias for the dd tag. Defines a term within a DescriptionList.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

DescriptionList(props)

Alias for the dl tag. The DescriptionList contains a number of DescriptionTerms and their definitions (DescriptionDefinition).

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

DescriptionTerm(props)

Alias for the dt tag. Contains a term within a DescriptionList, which can be described by a DescriptionDefinition.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

DescriptionDefinition(props)

Alias for the details tag. The Details tag provides additional details about a context that a user can show or hide on demand.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

EmailInput(props)

Alias for the input type="email" tag. Should be used when adding an email field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Embed(props)

Alias for the embed tag. The Embed tag defines a container for an external application or interactive content contained within a document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Emphasize(props)

Alias for the em tag. The Emphasize tag should be used to wrap text which should receive emphasis within its current context.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

FieldSet(props)

Alias for the fieldset tag. The FieldSet is used to group related elements within a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Figure(props)

Alias for the figure tag. The Figure element should contain self-contained content which is relevant to the current document, but which could be removed without impacting the flow of the current document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

FigureCaption(props)

Alias for the figcaption tag. The FigureCaption element defines a caption for a Figure element.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

FileInput(props)

Alias for the input type="file" tag. Should be used when adding a file field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Footer(props)

Alias for the footer tag. The Footer element defines a footer for a document or section. Content should be related to the parent.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Form(props)

Alias for the form tag. The Form element should be used to define a form for user input.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Head(props)

Alias for the head tag. The Head element should be used as a container for document-level meta data and to load linked resources.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Form(props)

Alias for the header tag. The Header element defines a Header for a document or section. It should contain content relevant to the parent.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Header(props)

Alias for the h1 to h6 tags. Requires a property of level which defines the level of the heading. The Heading element should be used to appropriately denote the structure of content as nested fragments.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object | | props.level | string | number |

HiddenInput(props)

Alias for the input type="hidden" tag. Should be used when adding a hidden field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

HorizontalRule(props)

Alias for the hr tag. The HorizontalRule element can be used to denote a thematic break in content.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Html(props)

Alias for the html tag. The Html element is a wrapper for an HTML document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

IFrame(props)

Alias for the iframe tag. The IFrame element can be used to embed a separate document into a document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Image(props)

Alias for the img tag. The Image element can be used to embed an image into a document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

FileInput(props)

Alias for the input type="image" tag. Should be used when adding an image field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Inline(props)

Alias for the span tag. An inline element can be used to define non-semantic inline structure in a document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Input(props)

Alias for the input tag. The Input element can be used to define a generic field within a form for user input.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Label(props)

Alias for the label tag. The Label element defines information relevant to an Input, Select, or TextArea.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Legend(props)

Alias for the legend tag. A Legend element provides a caption for a FieldSet.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

LineBreak(props)

Alias for the br tag. The LineBreak element breaks inline content to the next line.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Link(props)

Alias for the link tag. The Link element defines a relationship between a docuument and an external resource.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

List(props)

Alias for the ul tag. The List element provides a container for an unordered list.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

ListItem(props)

Alias for the li tag. The ListItem element denotes a child of an ordered or unordered list.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Main(props)

Alias for the main tag. The Main element provides a semantic container for the main content within a document. For backwards compatability for IE11 and previous, a role="main" should also be added.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Map(props)

Alias for the map tag. The Map element defines a map of Areas that allows regions of an image to be clickable.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Mark(props)

Alias for the mark tag. The Mark element defines text which should be highlighted within the context of surrounding text.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Meta(props)

Alias for the meta tag. The Meta element defines metadata about a document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

MonthInput(props)

Alias for the input type="month" tag. Should be used when adding a month field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Navigation(props)

Alias for the nav tag. The Navigation element defines a set of links for user naviation.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

NoScript(props)

Alias for the noscript tag. The NoScript tag defines content which displays in a browser if scripting is not enabled.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

NumberInput(props)

Alias for the input type="number" tag. Should be used when adding a number field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Option(props)

Alias for the option tag. The Option element defines a user-selectable value for a Select.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

OrderedList(props)

Alias for the ol tag. The OrderedList element provides a container for an ordered list.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Output(props)

Alias for the output tag. The Output element defines the result of a calculation.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Paragraph(props)

Alias for the p tag. The Paragraph element defines a paragraph of text.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

CheckBox(props)

Alias for the input type="password" tag. Should be used when adding a password field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Picture(props)

Alias for the picture tag. The Picture element allows for additionally flexibility in defining image resources above the Image element.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Preformat(props)

Alias for the pre tag. The Preformat element allows the display of monospaced font and preserves both spaces and line breaks.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

RadioInput(props)

Alias for the input type="radio" tag. Should be used when adding a radio field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

RadioInput(props)

Alias for the input type="range" tag. Should be used when adding a range field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

ResetInput(props)

Alias for the input type="reset" tag. Should be used when adding a reset field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Script(props)

Alias for the script tag. The Script element defines document scripting.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

SearchInput(props)

Alias for the input type="search" tag. Should be used when adding a search field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Section(props)

Alias for the section tag. The Section element defines standalone sections within a document. Do not use this for generic structure.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Select(props)

Alias for the select tag. The Select element defines a dropdown input for a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Source(props)

Alias for the source tag. The Source element defines a source for a media element such as Audio, video, or Picture.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Strong(props)

Alias for the strong tag. The Strong element defines text which should stand out from surrounding text.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Style(props)

Alias for the style tag. The Style element defines CSS styles for a document.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

SubmitInput(props)

Alias for the input type="submit" tag. Should be used when adding a submit field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Summary(props)

Alias for the summary tag. The Summary element defines a visible heading for a Details element.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Table(props)

Alias for the table tag. The Table element defines a table layout.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TableBody(props)

Alias for the tbody tag. The TableBody element defines the body of a Table.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TableCaption(props)

Alias for the caption tag. The TableCaption define a caption for a table and must be insterted directly after the tag.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TableCell(props)

Alias for the td tag. The TableCell element defines a single cell of a TableRow.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TableFooter(props)

Alias for the tfoot tag. The TableFooter element defines a footer for a Table.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TableHead(props)

Alias for the thead tag. The TableHead element defines a header for an entire Table.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TableHeaderCell(props)

Alias for the th tag. The TableHeaderCell element defines a table header cell.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TableRow(props)

Alias for the tr tag. The TableRow element defines a row of a Table.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TelephoneInput(props)

Alias for the input type="tel" tag. Should be used when adding a telephone field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TextArea(props)

Alias for the textarea tag. The TextArea element defines a freetext field for user input in a Form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TextInput(props)

Alias for the input type="text" tag. Should be used when adding a text field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Time(props)

Alias for the time tag. The Time element defines human-readable time-related information within the context of its parent.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

TimeInput(props)

Alias for the input type="time" tag. Should be used when adding a time field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Title(props)

Alias for the title tag. The Title element defines a document title and should be contained within Head.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Track(props)

Alias for the track tag. The Track element defines tracks for media elements.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

UrlInput(props)

Alias for the input type="url" tag. Should be used when adding a url field to a form.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

Video(props)

Alias for the video tag. The Video element defines embedded video content.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | props | Object |

alias(Tag, name) ⇒ func

The alias function generates a memoized function which renders a React Pure-Functional component.

Kind: global function
Since: 1.0.0

| Param | Type | | --- | --- | | Tag | string | | name | string |