#components

#Interfaces

#BaseEditorProps

Defined in: packages/ui/src/components/editor.tsx:17

#Properties

#content?

optional content: string

Defined in: packages/ui/src/components/editor.tsx:19

#formId?

optional formId: string

Defined in: packages/ui/src/components/editor.tsx:18

#isLoading?

optional isLoading: boolean

Defined in: packages/ui/src/components/editor.tsx:22

#onContent()

onContent: (value) => void

Defined in: packages/ui/src/components/editor.tsx:20

#Parameters

#value

string

#Returns

void

#placeholder?

optional placeholder: string

Defined in: packages/ui/src/components/editor.tsx:21

#Type Aliases

#EditorWrapperProps

EditorWrapperProps = React.PropsWithChildren<{ inputGroupProps?: React.ComponentProps<typeof InputGroup>; isLoading?: boolean; saveButton?: React.ReactNode; toggleButton?: React.ReactNode; }>

Defined in: packages/ui/src/components/editor.tsx:25

#Variables

#modeColors

const modeColors: object

Defined in: packages/ui/src/components/note.tsx:4

#Type Declaration

#error

error: string = ''

#info

info: string = 'text-blue-600'

#note

note: string = ''

#success

success: string = 'text-green-600'

#warning

warning: string = 'text-orange-600'

---

#modeIcons

const modeIcons: object

Defined in: packages/ui/src/components/note.tsx:12

#Type Declaration

#error

error: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>> = AlertCircle

#info

info: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>> = Info

#note

note: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>> = Info

#success

success: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>> = CheckCircle

#warning

warning: ForwardRefExoticComponent<Omit<LucideProps, "ref"> & RefAttributes<SVGSVGElement>> = MessageCircleWarning

#Functions

#ArrayIndex()

ArrayIndex(__namedParameters): Element

Defined in: packages/ui/src/components/array-index.tsx:3

#Parameters

#__namedParameters

#index

number

#Returns

Element

---

#BaseEditor()

BaseEditor(props): Element

Defined in: packages/ui/src/components/editor.tsx:139

Implementation of TextEditor with EditorWrapper

#Parameters

#props

BaseEditorProps & Omit<EditorWrapperProps, "children">

BaseEditor props (see BaseEditorProps & EditorWrapperProps)

#Returns

Element

JSX.Element

---

#CopyButton()

CopyButton(__namedParameters): Element

Defined in: packages/ui/src/components/copy-button.tsx:5

#Parameters

#__namedParameters

#value

string

#Returns

Element

---

#DescriptionLabel()

DescriptionLabel(__namedParameters): Element

Defined in: packages/ui/src/components/description-label.tsx:4

#Parameters

#__namedParameters

PropsWithChildren<HTMLAttributes<HTMLSpanElement>>

#Returns

Element

---

#EditorWrapper()

EditorWrapper(props): Element

Defined in: packages/ui/src/components/editor.tsx:65

Wraps an editor with controls allowing for opening into a dialog.

#Parameters

#props

EditorWrapperProps

EditorWrapper props (see EditorWrapperProps & InputGroupProps)

#Returns

Element

JSX.Element

---

#Explain()

Explain(__namedParameters): Element

Defined in: packages/ui/src/components/explain.tsx:3

#Parameters

#__namedParameters

#children

ReactElement

#content

ReactNode

#Returns

Element

---

#FieldItem()

FieldItem(__namedParameters): Element

Defined in: packages/ui/src/components/field.tsx:4

#Parameters

#__namedParameters

PropsWithChildren<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & object & VariantProps<(props?) => string>>

#Returns

Element

---

#GlowingSave()

GlowingSave(__namedParameters): Element

Defined in: packages/ui/src/components/glowing-save.tsx:25

#Parameters

#__namedParameters

#disabledExplain?

string

#isDisabled?

boolean

#isLoading?

boolean

#label?

string

#mode?

"edit" | "view" = 'view'

#onCancel?

() => void

#onSave

() => void

#size?

"default" | "xs" | "sm" | "lg" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | null

#Returns

Element

---

#Note()

Note(__namedParameters): Element

Defined in: packages/ui/src/components/note.tsx:20

#Parameters

#__namedParameters

object & ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & VariantProps<(props?) => string>

#Returns

Element

---

#NotSet()

NotSet(__namedParameters): Element

Defined in: packages/ui/src/components/not-set.tsx:1

#Parameters

#__namedParameters

#override?

ReactNode

#Returns

Element

---

#SimpleLabel()

SimpleLabel(__namedParameters): Element

Defined in: packages/ui/src/components/simple-label.tsx:3

#Parameters

#__namedParameters

PropsWithChildren<HTMLAttributes<HTMLSpanElement>>

#Returns

Element

---

#TextEditor()

TextEditor(props): Element

Defined in: packages/ui/src/components/editor.tsx:38

A simple, styled textarea component for editing multiline text

#Parameters

#props

BaseEditorProps & Omit<ClassAttributes<HTMLTextAreaElement> & TextareaHTMLAttributes<HTMLTextAreaElement>, "value" | "onChange" | "placeholder">

TextEditor props (see BaseEditorProps)

#Returns

Element

JSX.Element