Skip to content

TypeScript Components

🚧 Work in Progress

This page is a work in progress.

Interfaces

AuthEvent

Properties

token

type

url

BackEvent

Properties

type

Button

Button component.

Properties

className

htmlType

namedStyle

onClick

text

type

Code

Code component that renders code with syntax highlighting.

Properties

className

codeStyle

language

text

type

ContextType

Custom

Custom component that allows for special data to be rendered.

Properties

className

data

library

subType

type

DataModel

Details

Details associated with displaying a data model.

Properties

className

data

fields

type

Display

Description of how to display a value, either in a table or detail view.

Properties

mode

onClick

title

type

value

DisplayLookup

Description of how to display a value looked up from data, either in a table or detail view.

Properties

field

mode

onClick

tableWidthPercent

title

Div

A generic container component.

Properties

className

components

type

Error

Utility component used to display an error.

Properties

children

className

description

statusCode

title

type

FireEvent

Fire an event.

Properties

event

message

type

Footer

Footer component.

Properties

className

extraText

type

Form

Form component.

Properties

className

displayMode

footer

formFields

initial

loading

method

submitOnChange

submitTrigger

submitUrl

type

FormFieldBoolean

Form field for boolean input.

Properties

className

description

displayMode

error

initial

locked

mode

name

required

title

type

FormFieldFile

Form field for file input.

Properties

accept

className

description

displayMode

error

locked

multiple

name

required

title

type

FormFieldInput

Form field for basic input.

Properties

autocomplete

className

description

displayMode

error

htmlType

initial

locked

name

placeholder

required

title

type

FormFieldSelect

Form field for select input.

Properties

autocomplete

className

description

displayMode

error

initial

locked

multiple

name

options

placeholder

required

title

type

vanilla

FormFieldSelectSearch

Form field for searchable select input.

Properties

className

debounce

description

displayMode

error

initial

locked

multiple

name

placeholder

required

searchUrl

title

type

FormFieldTextarea

Form field for text area input.

Properties

autocomplete

className

cols

description

displayMode

error

initial

locked

name

placeholder

required

rows

title

type

GoToEvent

Properties

query

target

type

url

Heading

Heading component.

Properties

className

htmlId

level

text

type

Iframe

Iframe component that displays content from a URL.

Properties

className

height

sandbox

src

srcdoc

title

type

width

Image

Image container component.

Properties

alt

className

height

loading

onClick

referrerPolicy

src

type

width

Json

JSON component that renders JSON data.

Properties

className

type

value

Link component.

Properties

active

className

components

locked

mode

onClick

type

List of Link components.

Properties

className

mode

type

Markdown

Markdown component that renders markdown text.

Properties

className

codeStyle

text

type

Modal

Modal component that displays a modal dialog.

Properties

body

className

footer

openContext

openTrigger

title

type

ModelForm

Form component generated from a Pydantic model.

Properties

className

displayMode

footer

formFields

initial

loading

method

submitOnChange

submitTrigger

submitUrl

type

Navbar

Navbar component used for moving between pages.

Properties

className

title

titleEvent

type

Page

Similar to container in many UI frameworks, this acts as a root component for most pages.

Properties

className

components

type

PageEvent

Properties

clear

context

name

nextEvent

pushPath

type

PageTitle

Sets the title of the HTML page via the document.title property.

Properties

text

type

Pagination

Pagination component to use with tables.

Properties

className

page

pageCount

pageQueryParam

pageSize

total

type

Paragraph

Paragraph component that displays a string as a paragraph.

Properties

className

text

type

SelectGroup

Properties

label

options

SelectOption

Properties

label

value

ServerLoad

A component that will be replaced by the server with the component returned by the given URL.

Properties

components

loadTrigger

method

path

sse

sseRetry

type

Spinner

Spinner component that displays a loading spinner.

Properties

className

text

type

Table

Table component.

Properties

className

columns

data

noDataMessage

type

Text

Text component that displays a string.

Properties

text

type

Toast

Toast component that displays a toast message (small temporary message).

Properties

body

className

openContext

openTrigger

position

title

type

Video

Video component that displays a video or multiple videos.

Properties

autoplay

className

controls

height

loop

muted

poster

sources

type

width

Type Aliases

AnyEvent

ClassName

DisplayMode

Display mode for a value.

FastProps

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify python types, then run fastui generate <python-object> <typescript-output-file>.

JsonData

NamedStyle

SelectOptions