modules

@chelseaapps/react-native-elements / Exports

@chelseaapps/react-native-elements

Table of contents

Interfaces

• ButtonProps

• CheckboxSelectRowProps

• DefaultButtonProps

• DropdownItem

• DropdownLinkProps

• DropdownState

• ErrorWrapperProps

• FieldsErrors

• FieldsType

• IconProps

• InputPressableProps

• InputProps

• LoadingWrapperProps

• OptionalWrapperProps

• OutlineButtonProps

• RadioSelectRowProps

• RoundedButtonProps

• SwitchRowProps

• TextareaLinkProps

• TextareaProps

• TxtProps

• WrapperProps

Type aliases

• InputValidations

Functions

• Button

• CheckboxSelectRow

• DefaultButton

• DropdownLink

• ErrorWrapper

• Icon

• Input

• InputPressable

• LoadingWrapper

• OptionalWrapper

• OutlineButton

• RadioSelectRow

• RoundedButton

• SwitchRow

• Textarea

• TextareaLink

• Txt

• Wrapper

Type aliases

InputValidations

Ƭ InputValidations<T>: { [K in keyof T]: RegisterOptions }

Type parameters

Name
T

Defined in

src/index.tsx:148

Functions

Button

▸ Const Button(props): Element

Initial button component

Parameters

Name	Type
props	ButtonProps

Returns

Element

A pressable text.

Defined in

src/index.tsx:81

---

CheckboxSelectRow

▸ Const CheckboxSelectRow(props): Element

Checkbox Row Component to be used as part of selectDropdown page

Parameters

Name	Type
props	CheckboxSelectRowProps

Returns

Element

A pressable row that changes dropdown state.

Defined in

src/index.tsx:119

---

DefaultButton

▸ Const DefaultButton(props): Element

Button with a full background colors and rounded corners

Parameters

Name	Type
props	DefaultButtonProps

Returns

Element

A pressable button.

Defined in

src/index.tsx:90

---

DropdownLink

▸ Const DropdownLink(props): Element

Dropdown Select Component

Parameters

Name	Type
props	DropdownLinkProps

Returns

Element

A pressable container that links to the selection page.

Defined in

src/index.tsx:132

---

ErrorWrapper

▸ Const ErrorWrapper(props): Element

A variation of the wrapper component.

Parameters

Name	Type
props	ErrorWrapperProps

Returns

Element

A Wrapper component that will check if there were any issues with the API Queries. Can be used only with CA GraphQL APIs.

Defined in

src/index.tsx:256

---

Icon

▸ Const Icon(props): Element

Global Icon component

Parameters

Name	Type
props	IconProps

Returns

Element

Highly customizable Icon component that can output a Font icon (https://oblador.github.io/react-native-vector-icons/) or a custom SVG icon.

Defined in

src/index.tsx:143

---

Input

▸ Const Input(props): Element

Animated Input Component

Parameters

Name	Type
props	InputProps

Returns

Element

Ready to use Input with validation from react hook form

Defined in

src/index.tsx:155

---

InputPressable

▸ Const InputPressable(props): Element

Static "fake" Input

Parameters

Name	Type
props	InputPressableProps

Returns

Element

Input component that can be pressed

Defined in

src/index.tsx:164

---

LoadingWrapper

▸ Const LoadingWrapper(props): Element

Loading Wrapper component

Parameters

Name	Type
props	LoadingWrapperProps

Returns

Element

Container to be used as the loading indicator on all pages.

Defined in

src/index.tsx:237

---

OptionalWrapper

▸ Const OptionalWrapper<T>(props): Element

A component that replaces the need to check for data in JSX (data ? : <></>)

Type parameters

Name	Type
T	extends unknown

Parameters

Name	Type
props	OptionalWrapperProps<T>

Returns

Element

A container view.

Defined in

src/index.tsx:247

---

OutlineButton

▸ Const OutlineButton(props): Element

Button with a transparent background color and rounded border

Parameters

Name	Type
props	OutlineButtonProps

Returns

Element

A pressable button.

Defined in

src/index.tsx:99

---

RadioSelectRow

▸ Const RadioSelectRow(props): Element

Radio Row Component to be used as part of selectDropdown page

Parameters

Name	Type
props	RadioSelectRowProps

Returns

Element

A pressable row that changes dropdown state.

Defined in

src/index.tsx:175

---

RoundedButton

▸ Const RoundedButton(props): Element

Button with a full background and full rounded corners

Parameters

Name	Type
props	RoundedButtonProps

Returns

Element

A pressable button.

Defined in

src/index.tsx:108

---

SwitchRow

▸ Const SwitchRow(props): Element

Switch component

Parameters

Name	Type
props	SwitchRowProps

Returns

Element

A component that can change a boolean state with a switch. It's not part of the react hook form.

Defined in

src/index.tsx:186

---

Textarea

▸ Const Textarea(props): Element

Expandable Textarea component

Parameters

Name	Type	Description
props	TextareaProps	Inherited from the InputProps

Returns

Element

A textarea that can change its height based on the value inside. Validation based on react-hook-form.

Defined in

src/index.tsx:197

---

TextareaLink

▸ Const TextareaLink(props): Element

Textarea component that links to a different page

Parameters

Name	Type
props	TextareaLinkProps

Returns

Element

A textarea that changes the current page to enter the value. Dependent on textareaEdit page. Validation based on react-hook-form.

Defined in

src/index.tsx:208

---

Txt

▸ Const Txt(props): Element

Global Text Component

Parameters

Name	Type
props	TxtProps

Returns

Element

A text component that has the specific project fonts and sizing. To be used everywhere within the app.

Defined in

src/index.tsx:219

---

Wrapper

▸ Const Wrapper(props): Element

Wrapper component

Parameters

Name	Type
props	WrapperProps

Returns

Element

Component to be used as the main container on all pages.

Defined in

src/index.tsx:228