@bestdoctor/ke-beta

Index

Enumerations

Classes

Interfaces

Functions

Type Aliases

Accessor

Accessor<T>: T | Function | undefined

Type Parameters

ArrayData

ArrayData<T>: FieldData<T>[]

Type Parameters

T = unknown

ArrayValidator

ArrayValidator: ((value: unknown) => Promise<ValidationResult[]>)

Type declaration

- (value: unknown): Promise<ValidationResult[]>
- Parameters
  - value: unknown
  Returns Promise<ValidationResult[]>

BaseConfig

BaseConfig: Record<string, any>

ConfigConsumerOptionsOrKey

ConfigConsumerOptionsOrKey<Config>: ConfigConsumerOptions<Config> | string

Type Parameters

Config extends BaseConfig

DetailFieldDescription

DetailFieldDescription: { blockingValidators?: WidgetValueValidator[]; dataSource?: GenericAccessor; dataTarget?: GenericAccessor; description?: GenericAccessor; displayValue?: GenericAccessor; helpText?: string; href?: GenericAccessor; layout: LayoutData; name: string; notBlockingValidators?: WidgetValueValidator[]; required?: Accessor<boolean>; showWidget?: Accessor<boolean>; targetPayload?: GenericAccessor; widget: FunctionComponent<any> | Function; widgetAnalytics?: GenericAccessor }

Type declaration

Optional blockingValidators?: WidgetValueValidator[]
Optional dataSource?: GenericAccessor
Optional dataTarget?: GenericAccessor
Optional description?: GenericAccessor
Optional displayValue?: GenericAccessor
Optional helpText?: string
Optional href?: GenericAccessor
layout: LayoutData
name: string
Optional notBlockingValidators?: WidgetValueValidator[]
Optional required?: Accessor<boolean>
Optional showWidget?: Accessor<boolean>
Optional targetPayload?: GenericAccessor
widget: FunctionComponent<any> | Function
Optional widgetAnalytics?: GenericAccessor

FetchFn

FetchFn<ResourceData>: ((resourceKey: string, config?: RequestConfig, pageParams?: any) => Promise<ResourceData>)

Type Parameters

ResourceData = unknown

Type declaration

- (resourceKey: string, config?: RequestConfig, pageParams?: any): Promise<ResourceData>
- Parameters
  - resourceKey: string
  - Optional config: RequestConfig
  - Optional pageParams: any
  Returns Promise<ResourceData>

FieldKey

FieldKey: string | number

FieldProps

FieldProps<T, P>: BaseFieldProps<T, P> & Omit<P, keyof BaseFieldProps<T, P> | keyof ControlProps<T>> & { isRequired?: boolean; label?: ReactElement }

Type Parameters

GenericAccessor

GenericAccessor: string | Function | JSX.Element | undefined

HttpClient

HttpClient: AxiosInstance

HttpResponse

HttpResponse<T>: AxiosResponse<T>

Type Parameters

T = any

InputWidgetProps

InputWidgetProps: WidgetProps & { debounce?: number; height?: number; inputProps?: StyleProps; isDisabled?: Accessor<boolean>; isTextarea?: boolean; textareaResize?: TextareaProps["resize"] }

LayoutComponent

LayoutComponent<Children, Props>: ((props: LayoutProps<Children, Props>) => JSX.Element)

Type Parameters

Children
Props = {}

Type declaration

- (props: LayoutProps<Children, Props>): JSX.Element
- Parameters
  - props: LayoutProps<Children, Props>
  Returns JSX.Element

LayoutProps

LayoutProps<Children, Props>: Props & { children: Children }

Type Parameters

Children
Props = {}

ListFieldDescription

ListFieldDescription: { Cell?: Function; Header: string; accessor?: any }

Type declaration

Optional Cell?: Function
Header: string
Optional accessor?: any

ListFilterDescription

ListFilterDescription: { Filter: FunctionComponent<any>; label: string; name: Accessor<string> }

Type declaration

Filter: FunctionComponent<any>
label: string
name: Accessor<string>

ListFilterTemplateDescription

ListFilterTemplateDescription: { filters: Function; label: string; name: string; style?: { colorScheme?: string; variant?: "outline" | "ghost" | "unstyled" | "link" | "solid" } }

Type declaration

filters: Function
label: string
name: string
Optional style?: { colorScheme?: string; variant?: "outline" | "ghost" | "unstyled" | "link" | "solid" }
- Optional colorScheme?: string
- Optional variant?: "outline" | "ghost" | "unstyled" | "link" | "solid"

MergeConfigs

MergeConfigs<ConfigType>: ((a: Partial<ConfigType>, b: Partial<ConfigType>) => ConfigType)

Type Parameters

ConfigType extends BaseConfig

Type declaration

- (a: Partial<ConfigType>, b: Partial<ConfigType>): ConfigType
- Parameters
  - a: Partial<ConfigType>
  - b: Partial<ConfigType>
  Returns ConfigType

NextStep

NextStep<Action, StepData>: ((nextKey: Action, data: StepData, submit?: ((data: unknown) => void)) => void)

Type Parameters

Action
StepData

Type declaration

- (nextKey: Action, data: StepData, submit?: ((data: unknown) => void)): void
- Parameters
  - nextKey: Action
  - data: StepData
  - Optional submit: ((data: unknown) => void)
    - - (data: unknown): void
      - Parameters
        data: unknown
        Returns void
  Returns void

OnDetailObjectLoadedProps

OnDetailObjectLoadedProps: { context: object; mainDetailObject: Model; provider: Provider; setInitialValue: Function }

Type declaration

context: object
mainDetailObject: Model
provider: Provider
setInitialValue: Function

OnProgress

OnProgress: ((event: { loaded: number; total?: number }) => void)

Type declaration

- (event: { loaded: number; total?: number }): void
- Parameters
  - event: { loaded: number; total?: number }
    - loaded: number
    - Optional total?: number
  Returns void

OrderedTableProps

OrderedTableProps<T>: TableProps<T> & { orderedColumnNames: (string | number)[]; ordering?: Record<string | number, OrderDirection>; onOrderChange: any }

Type Parameters

PropsWithDefaultLayout

PropsWithDefaultLayout<P, R>: P & Partial<AddLayoutProps<R>>

Type Parameters

PropsWithLayout

PropsWithLayout<P, R>: P & AddLayoutProps<R>

Type Parameters

ProviderOptions

ProviderOptions: { onError?: ErrorHandler; requestConfig?: AxiosRequestConfig }

Type declaration

Optional onError?: ErrorHandler
Optional requestConfig?: AxiosRequestConfig

RecordData

RecordData<K>: Record<K, FieldData>

Type Parameters

K extends FieldKey = FieldKey

RecordValidator

RecordValidator: ((value: unknown) => Promise<Record<string, ValidationResult>>)

Type declaration

- (value: unknown): Promise<Record<string, ValidationResult>>
- Parameters
  - value: unknown
  Returns Promise<Record<string, ValidationResult>>

ResourceOptionsOrKey

ResourceOptionsOrKey<T>: T | string

Type Parameters

T extends KeyConfig

ResourceProviderOptions

ResourceProviderOptions: Partial<ResourceProviderConfig>

SelectObject

SelectObject: { text: string; value: string }

Type declaration

text: string
value: string

SlotElements

SlotElements<K>: { [ P in K]?: JSX.Element | string }

Type Parameters

K extends string

TPathRules

TPathRules: {}

Type declaration

[key: string]: TPathRule

TableWithHidableColumnsProps

TableWithHidableColumnsProps<T>: TableProps<T> & { visibleColumnsPersistName: string }

Type Parameters

UseTestIdProps

UseTestIdProps: TestIdGenerationProps

Validator

Validator: ((value: unknown) => Promise<ValidationResult>)

Type declaration

- (value: unknown): Promise<ValidationResult>
- Parameters
  - value: unknown
  Returns Promise<ValidationResult>

ValidatorFunction

ValidatorFunction: ((changeValue: object | string, provider: Provider, detailObject: DetailObject, context?: Record<string, unknown>) => Promise<string>)

Type declaration

- (changeValue: object | string, provider: Provider, detailObject: DetailObject, context?: Record<string, unknown>): Promise<string>
- Parameters
  - changeValue: object | string
  - provider: Provider
  - detailObject: DetailObject
  - Optional context: Record<string, unknown>
  Returns Promise<string>

WidgetPayload

WidgetPayload: { payload: object; url: string }

Type declaration

payload: object
url: string

WidgetProps

WidgetProps: { activeWizardRef?: MutableRefObject<WizardControl | null>; allowAllDefinedValues?: Accessor<boolean>; analytics?: BaseAnalytic; blockingValidators?: ValidatorFunction[]; cacheTime?: Accessor<number>; className?: string; containerErrorsStore?: Store<ErrorElement[]>; containerProps?: BoxProps; containerStore: Store<object>; copyValue?: GenericAccessor; dataSource: GenericAccessor; dataTarget: GenericAccessor; description?: string | JSX.Element; displayValue?: GenericAccessor; helpText?: string; labelContainerProps?: BoxProps; mainDetailObject: DetailObject; name: string; notBlockingValidators?: ValidatorFunction[]; notifier: BaseNotifier; provider: Provider; required?: Accessor<boolean>; resource: string; setInitialValue: Function; setMainDetailObject: Function; style?: CSSProperties; submitChange: Function; targetPayload: Function; useClipboard?: boolean; viewType: string; widgetAnalytics?: Function | boolean; widgetClassName?: string } & Omit<TestIdGenerationProps, "name">

WizardFieldDescription

WizardFieldDescription: WizardFieldElement[]

WizardPayload

WizardPayload: {}

Type declaration

[key: string]: any

WizardProps

WizardProps: { ViewType: string; activeWizardRef: MutableRefObject<WizardControl | null>; allowToggle?: Accessor<boolean>; analytics?: BaseAnalytic; isExpanded?: Accessor<boolean>; mainDetailObject: DetailObject; notifier: BaseNotifier; provider: Provider; refreshMainDetailObject: Function; resourceName: string; setMainDetailObject: Function; style?: object; user: object; wizard: BaseWizard }

Type declaration

ViewType: string
activeWizardRef: MutableRefObject<WizardControl | null>
Optional allowToggle?: Accessor<boolean>
Optional analytics?: BaseAnalytic
Optional isExpanded?: Accessor<boolean>
mainDetailObject: DetailObject
notifier: BaseNotifier
provider: Provider
refreshMainDetailObject: Function
resourceName: string
setMainDetailObject: Function
Optional style?: object
user: object
wizard: BaseWizard

WizardState

WizardState: Promise<string>

WizardStepButtonDescription

WizardStepButtonDescription: { isDisabled?: boolean; label: string | undefined; name: string; needErrorClean?: boolean; needValidation?: boolean; onHandlingLabel?: string; style: Style; handler: any }

Type declaration

Optional isDisabled?: boolean
label: string | undefined
name: string
Optional needErrorClean?: boolean
Optional needValidation?: boolean
Optional onHandlingLabel?: string
style: Style
handler:function
- handler(props: any): Promise<string>
- - Defined in src/WizardMaster/buttons.ts:7
  Parameters
  - props: any
  Returns Promise<string>

Variables

Const AdminResource

AdminResource: FC<AdminResourceProps> = ...

Const AdminResourceCompatible

AdminResourceCompatible: FC<AdminResourceCompatibleProps> = ...

Const AnalyticsProvider

AnalyticsProvider: Provider<AnalyticsHandler> = analyticsContext.Provider

Const BaseSelectWidget

BaseSelectWidget: ForwardRefExoticComponent<BaseSelectWidgetProps & RefAttributes<HTMLSelectElement>> = ...

Const CheckBox

CheckBox: ForwardRefExoticComponent<ControlProps<boolean> & { helpText?: string } & Omit<CheckboxProps, "onChange" | "value"> & RefAttributes<HTMLInputElement>> = ...

Const ChipInput

ChipInput: ForwardRefExoticComponent<ControlProps<string[]> & { chipClassName?: string; errorText?: string; inputClassName?: string; placeholder?: string; submitKeys?: string[]; validator?: any } & RefAttributes<HTMLInputElement>> = ...

Const DateInput

DateInput: ForwardRefExoticComponent<DateInputProps & RefAttributes<HTMLInputElement>> = ...

Const DateTimeInput

DateTimeInput: ForwardRefExoticComponent<DateTimeInputProps & RefAttributes<HTMLInputElement>> = ...

Const EmailChipInput

EmailChipInput: ForwardRefExoticComponent<EmailChipInputProps & RefAttributes<HTMLInputElement>> = ...

Const FiltersIntegrator

FiltersIntegrator: Integrator<FC<RootProps>, { Filters: PolymorphComponent<{ filters: unknown; onChange: ((filters: unknown) => void) }>; Predefined: PolymorphComponent<{ onChange: ((filters: unknown) => void); value: unknown }> }> = ...

Const Input

Const InputWidget

InputWidget: ForwardRefExoticComponent<{ activeWizardRef?: MutableRefObject<null | WizardControl>; allowAllDefinedValues?: Accessor<boolean>; analytics?: BaseAnalytic; blockingValidators?: ValidatorFunction[]; cacheTime?: Accessor<number>; className?: string; containerErrorsStore?: Store<ErrorElement[]>; containerProps?: BoxProps; containerStore: Store<object>; copyValue?: GenericAccessor; dataSource: GenericAccessor; dataTarget: GenericAccessor; description?: string | Element; displayValue?: GenericAccessor; helpText?: string; labelContainerProps?: BoxProps; mainDetailObject: DetailObject; name: string; notBlockingValidators?: ValidatorFunction[]; notifier: BaseNotifier; provider: Provider; required?: Accessor<boolean>; resource: string; setInitialValue: Function; setMainDetailObject: Function; style?: CSSProperties; submitChange: Function; targetPayload: Function; useClipboard?: boolean; viewType: string; widgetAnalytics?: boolean | Function; widgetClassName?: string } & Omit<TestIdGenerationProps, "name"> & { debounce?: number; height?: number; inputProps?: StyleProps; isDisabled?: Accessor<boolean>; isTextarea?: boolean; textareaResize?: ResponsiveValue<Resize> } & RefAttributes<HTMLInputElement>> = ...

Const ListIntegrator

ListIntegrator: Integrator<FC<ContextsData<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; status: Context<Readonly<StatusContext>> }>>, { Data: PolymorphComponent<{ isLoading?: boolean; isNotLoaded?: boolean; items: unknown[] }>; Filters: PolymorphComponent<{ filters: unknown; isLoading?: boolean; onChange: any }>; Order: PolymorphComponent<{ isLoading?: boolean; order: unknown; onChange: any }>; Pagination: PolymorphComponent<{ currentPage: number; isLoading?: boolean; totalPages: number; onChange: any }> }> = ...

Компонент-интегратор для управления списком записей получаемых с сервера в стандартной связке:

элементы
фильтры
сортировка
пагинация
текущий статус получения данных

В корневой элемент передаются параметры запроса и данные полученные по этому запросу

Const LoggerProvider

LoggerProvider: Provider<LoggingHandler> = loggerContext.Provider

Const NotificationsProvider

NotificationsProvider: Provider<NotificationsHandler> = notificationsContext.Provider

Const OrderedTable

OrderedTable: ComponentType<{ as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableElement> & TableHTMLAttributes<HTMLTableElement> & SortingProps & { children?: undefined; columns: readonly ColumnConfig<unknown, { as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableHeaderCellElement> & ThHTMLAttributes<HTMLTableHeaderCellElement> & { children?: ReactNode }, { as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableDataCellElement> & TdHTMLAttributes<HTMLTableDataCellElement> & { children?: ReactNode }, unknown, unknown>[]; data: readonly unknown[]; dataRow?: DataRowDesc<{ as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableRowElement> & HTMLAttributes<HTMLTableRowElement> & { children?: ReactNode }, unknown, unknown>; headerRow?: HeaderRowDesc<{ as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableRowElement> & HTMLAttributes<HTMLTableRowElement> & { children?: ReactNode }, unknown>; getKey?: any }> = ...

Const PhoneChipInput

PhoneChipInput: ForwardRefExoticComponent<PhoneChipInputProps & RefAttributes<HTMLInputElement>> = ...

Const RegexInputWidget

RegexInputWidget: ForwardRefExoticComponent<{ activeWizardRef?: MutableRefObject<null | WizardControl>; allowAllDefinedValues?: Accessor<boolean>; analytics?: BaseAnalytic; blockingValidators?: ValidatorFunction[]; cacheTime?: Accessor<number>; className?: string; containerErrorsStore?: Store<ErrorElement[]>; containerProps?: BoxProps; containerStore: Store<object>; copyValue?: GenericAccessor; dataSource: GenericAccessor; dataTarget: GenericAccessor; description?: string | Element; displayValue?: GenericAccessor; helpText?: string; labelContainerProps?: BoxProps; mainDetailObject: DetailObject; name: string; notBlockingValidators?: ValidatorFunction[]; notifier: BaseNotifier; provider: Provider; required?: Accessor<boolean>; resource: string; setInitialValue: Function; setMainDetailObject: Function; style?: CSSProperties; submitChange: Function; targetPayload: Function; useClipboard?: boolean; viewType: string; widgetAnalytics?: boolean | Function; widgetClassName?: string } & Omit<TestIdGenerationProps, "name"> & { debounce?: number; height?: number; isDisabled?: Accessor<boolean>; regexp: RegExp } & RefAttributes<HTMLInputElement>> = ...

Const RenderList

RenderList: React.FC<{ admin: BaseAdmin; analytics?: BaseAnalytic; provider: Provider; resourceName: string; user: any }> = ...

Async load models and render them as paginated table. Change page title.

param resourceName: using for analytics
param admin: meta-information fo rendered models
param provider: used for requests to backend
param user: used for filter query
param analytics: for send analytics event

Const Resource

Resource: FC<ResourceProps> = ...

Const ResourceComposer

ResourceComposer: FC<ResourceComposerProps> = ...

Const ResourceConfigContext

ResourceConfigContext: Context<null | ResourceDefaultConfig<unknown, unknown>> = ...

Const SaveEventProvider

SaveEventProvider: React.FC = ...

Const SelectListIntegrator

SelectListIntegrator: Integrator<FC<ContextsData<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; selected: Context<readonly [unknown[], ((selected: unknown[]) => void)]>; status: Context<Readonly<StatusContext>> }>>, { Data: PolymorphComponent<{ isLoading?: boolean; isNotLoaded?: boolean; items: unknown[]; selected?: unknown[]; onSelectedChange?: any }>; Filters: PolymorphComponent<{ filters: unknown; isLoading?: boolean; onChange: any }>; Order: PolymorphComponent<{ isLoading?: boolean; order: unknown; onChange: any }>; Pagination: PolymorphComponent<{ currentPage: number; isLoading?: boolean; totalPages: number; onChange: any }>; Selected: PolymorphComponent<{ isLoading?: boolean; selected: unknown[]; total?: number; onSelectedChange?: any }> }> = ...

Компонент-интегратор для управления списком записей получаемых с сервера в стандартной связке:

элементы
фильтры
сортировка
пагинация
текущий статус получения данных

С дополнительной возможностью выбора подмассива записей и организации пакетных операций над ними. Технически, с помощь данного интегратора можно реализовать компонент с функциональностью Select

В корневой элемент передаются параметры запроса и данные полученные по этому запросу, а также текущие выбранные записи Важно отметить: на этом этапе не производится никаких проверок, что выбранные элементы являются подмассивом к основным.

Const SelectListPattern

SelectListPattern: Integrator<(<T>(p: SelectListPatternProps<T>) => ReactElement<any, string | JSXElementConstructor<any>>), { Data: PolymorphComponent<{ isLoading?: boolean; isNotLoaded?: boolean; items: unknown[]; selected?: unknown[]; onSelectedChange?: any }>; Filters: PolymorphComponent<{ filters: unknown; isLoading?: boolean; onChange: any }>; Order: PolymorphComponent<{ isLoading?: boolean; order: unknown; onChange: any }>; Pagination: PolymorphComponent<{ currentPage: number; isLoading?: boolean; totalPages: number; onChange: any }>; Selected: PolymorphComponent<{ isLoading?: boolean; selected: unknown[]; total?: number; onSelectedChange?: any }> }> = ...

Паттерн для вывода списка с поддержкой фильтрации/пагинации и выбором элементов из списка.

С помощью данного паттерна можно реализовать, multi-select

Const SelectTable

SelectTable: ComponentType<{ as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableElement> & TableHTMLAttributes<HTMLTableElement> & SortingProps & SelectProps<unknown> & { children?: undefined; columns: readonly ColumnConfig<unknown, { as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableHeaderCellElement> & ThHTMLAttributes<HTMLTableHeaderCellElement> & { children?: ReactNode }, { as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableDataCellElement> & TdHTMLAttributes<HTMLTableDataCellElement> & { children?: ReactNode }, unknown, unknown>[]; data: readonly unknown[]; dataRow?: DataRowDesc<{ as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableRowElement> & HTMLAttributes<HTMLTableRowElement> & { children?: ReactNode }, unknown, unknown>; headerRow?: HeaderRowDesc<{ as?: ElementType<any>; theme?: Theme } & ClassAttributes<HTMLTableRowElement> & HTMLAttributes<HTMLTableRowElement> & { children?: ReactNode }, unknown>; getKey?: any }> = ...

Const SelectWidget

SelectWidget: ForwardRefExoticComponent<SelectWidgetProps & RefAttributes<HTMLSelectElement>> = ...

Const StyleDateTime

StyleDateTime: StyledComponent<{ as?: ElementType<any>; theme?: Theme }, DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}> = ...

Const Switch

Switch: ForwardRefExoticComponent<ControlProps<boolean> & { helpText?: string } & Omit<SwitchProps, "onChange" | "value"> & RefAttributes<HTMLInputElement>> = ...

Const TestIdProvider

TestIdProvider: React.FC<TestIdProviderProps> = ...

Const TextEditor

TextEditor: ForwardRefExoticComponent<TextEditorProps & RefAttributes<HTMLDivElement>> = ...

Const Textarea

Const ValidationWrapper

ValidationWrapper: React.FC<ValidationWrapperProps> = ...

Wrapper component to adding validation checks. Can be used only for children with handleChange prop.

param children: standard react children
param blockingValidators: fail in this validators will be shown as error
param notBlockingValidators: fail in this validators will be shown as info
param provider: provider for backend request, will be passed as second param to validators
param detailObject: addition object, will be passed as third param to validators
param context: current context

Const WidgetWrapper

WidgetWrapper: React.FC<WidgetWrapperProps> = ...

Standard styled container for other widgets

param style: container css styles
param helpText: inner widget(s) label
param children: standard react children
param copyValue: returns of this callback will be copy to clipboard (when use)
param useClipboard: show "copy-to-clipboard" handler
param notifier: object for send notification text on "copy-to-clipboard" event
param name: name data-attribute
param description: description

Const clearErrors

clearErrors: Event<void> = ...

Const defaultTheme

defaultTheme: { blur: { 2xl: string; 3xl: string; base: string; lg: string; md: string; none: number; sm: string; xl: string }; borders: { 1px: string; 2px: string; 4px: string; 8px: string; none: number }; breakpoints: Breakpoints<{ 2xl: string; lg: string; md: string; sm: string; xl: string }>; colors: { black: string; blackAlpha: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; blue: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; current: string; cyan: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; facebook: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; gray: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; green: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; linkedin: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; messenger: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; orange: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; pink: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; purple: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; red: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; teal: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; telegram: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; transparent: string; twitter: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; whatsapp: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; white: string; whiteAlpha: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; yellow: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string } }; components: __module; config: ThemeConfig; direction: "ltr"; fontSizes: { 2xl: string; 3xl: string; 4xl: string; 5xl: string; 6xl: string; 7xl: string; 8xl: string; 9xl: string; lg: string; md: string; sm: string; xl: string; xs: string }; fontWeights: { black: number; bold: number; extrabold: number; hairline: number; light: number; medium: number; normal: number; semibold: number; thin: number }; fonts: { body: string; heading: string; mono: string }; letterSpacings: { normal: string; tight: string; tighter: string; wide: string; wider: string; widest: string }; lineHeights: { 10: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; base: number; none: number; normal: string; short: number; shorter: number; tall: number; taller: string }; radii: { 2xl: string; 3xl: string; base: string; full: string; lg: string; md: string; none: string; sm: string; xl: string }; shadows: { 2xl: string; base: string; dark-lg: string; inner: string; lg: string; md: string; none: string; outline: string; sm: string; xl: string; xs: string }; sizes: { 0.5: string; 1: string; 1.5: string; 10: string; 12: string; 14: string; 16: string; 2: string; 2.5: string; 20: string; 24: string; 28: string; 2xl: string; 2xs: string; 3: string; 3.5: string; 32: string; 36: string; 3xl: string; 3xs: string; 4: string; 40: string; 44: string; 48: string; 4xl: string; 5: string; 52: string; 56: string; 5xl: string; 6: string; 60: string; 64: string; 6xl: string; 7: string; 72: string; 7xl: string; 8: string; 80: string; 8xl: string; 9: string; 96: string; container: { lg: string; md: string; sm: string; xl: string }; full: string; lg: string; max: string; md: string; min: string; px: string; sm: string; xl: string; xs: string }; space: { 0.5: string; 1: string; 1.5: string; 10: string; 12: string; 14: string; 16: string; 2: string; 2.5: string; 20: string; 24: string; 28: string; 3: string; 3.5: string; 32: string; 36: string; 4: string; 40: string; 44: string; 48: string; 5: string; 52: string; 56: string; 6: string; 60: string; 64: string; 7: string; 72: string; 8: string; 80: string; 9: string; 96: string; px: string }; styles: Styles; transition: { duration: { fast: string; faster: string; normal: string; slow: string; slower: string; ultra-fast: string; ultra-slow: string }; easing: { ease-in: string; ease-in-out: string; ease-out: string }; property: { background: string; colors: string; common: string; dimensions: string; position: string } }; zIndices: { auto: string; banner: number; base: number; docked: number; dropdown: number; hide: number; modal: number; overlay: number; popover: number; skipLink: number; sticky: number; toast: number; tooltip: number } } = ...

Type declaration

blur: { 2xl: string; 3xl: string; base: string; lg: string; md: string; none: number; sm: string; xl: string }
- 2xl: string
- 3xl: string
- base: string
- lg: string
- md: string
- none: number
- sm: string
- xl: string
borders: { 1px: string; 2px: string; 4px: string; 8px: string; none: number }
- 1px: string
- 2px: string
- 4px: string
- 8px: string
- none: number
breakpoints: Breakpoints<{ 2xl: string; lg: string; md: string; sm: string; xl: string }>
colors: { black: string; blackAlpha: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; blue: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; current: string; cyan: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; facebook: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; gray: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; green: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; linkedin: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; messenger: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; orange: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; pink: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; purple: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; red: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; teal: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; telegram: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; transparent: string; twitter: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; whatsapp: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; white: string; whiteAlpha: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }; yellow: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string } }
- black: string
- blackAlpha: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- blue: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- current: string
- cyan: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- facebook: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- gray: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- green: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- linkedin: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- messenger: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- orange: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- pink: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- purple: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- red: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- teal: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- telegram: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- transparent: string
- twitter: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- whatsapp: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- white: string
- whiteAlpha: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
- yellow: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }
  - 100: string
  - 200: string
  - 300: string
  - 400: string
  - 50: string
  - 500: string
  - 600: string
  - 700: string
  - 800: string
  - 900: string
components: __module
config: ThemeConfig
direction: "ltr"
fontSizes: { 2xl: string; 3xl: string; 4xl: string; 5xl: string; 6xl: string; 7xl: string; 8xl: string; 9xl: string; lg: string; md: string; sm: string; xl: string; xs: string }
- 2xl: string
- 3xl: string
- 4xl: string
- 5xl: string
- 6xl: string
- 7xl: string
- 8xl: string
- 9xl: string
- lg: string
- md: string
- sm: string
- xl: string
- xs: string
fontWeights: { black: number; bold: number; extrabold: number; hairline: number; light: number; medium: number; normal: number; semibold: number; thin: number }
- black: number
- bold: number
- extrabold: number
- hairline: number
- light: number
- medium: number
- normal: number
- semibold: number
- thin: number
fonts: { body: string; heading: string; mono: string }
- body: string
- heading: string
- mono: string
letterSpacings: { normal: string; tight: string; tighter: string; wide: string; wider: string; widest: string }
- normal: string
- tight: string
- tighter: string
- wide: string
- wider: string
- widest: string
lineHeights: { 10: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; base: number; none: number; normal: string; short: number; shorter: number; tall: number; taller: string }
- 10: string
- 3: string
- 4: string
- 5: string
- 6: string
- 7: string
- 8: string
- 9: string
- base: number
- none: number
- normal: string
- short: number
- shorter: number
- tall: number
- taller: string
radii: { 2xl: string; 3xl: string; base: string; full: string; lg: string; md: string; none: string; sm: string; xl: string }
- 2xl: string
- 3xl: string
- base: string
- full: string
- lg: string
- md: string
- none: string
- sm: string
- xl: string
shadows: { 2xl: string; base: string; dark-lg: string; inner: string; lg: string; md: string; none: string; outline: string; sm: string; xl: string; xs: string }
- 2xl: string
- base: string
- dark-lg: string
- inner: string
- lg: string
- md: string
- none: string
- outline: string
- sm: string
- xl: string
- xs: string
sizes: { 0.5: string; 1: string; 1.5: string; 10: string; 12: string; 14: string; 16: string; 2: string; 2.5: string; 20: string; 24: string; 28: string; 2xl: string; 2xs: string; 3: string; 3.5: string; 32: string; 36: string; 3xl: string; 3xs: string; 4: string; 40: string; 44: string; 48: string; 4xl: string; 5: string; 52: string; 56: string; 5xl: string; 6: string; 60: string; 64: string; 6xl: string; 7: string; 72: string; 7xl: string; 8: string; 80: string; 8xl: string; 9: string; 96: string; container: { lg: string; md: string; sm: string; xl: string }; full: string; lg: string; max: string; md: string; min: string; px: string; sm: string; xl: string; xs: string }
- 0.5: string
- 1: string
- 1.5: string
- 10: string
- 12: string
- 14: string
- 16: string
- 2: string
- 2.5: string
- 20: string
- 24: string
- 28: string
- 2xl: string
- 2xs: string
- 3: string
- 3.5: string
- 32: string
- 36: string
- 3xl: string
- 3xs: string
- 4: string
- 40: string
- 44: string
- 48: string
- 4xl: string
- 5: string
- 52: string
- 56: string
- 5xl: string
- 6: string
- 60: string
- 64: string
- 6xl: string
- 7: string
- 72: string
- 7xl: string
- 8: string
- 80: string
- 8xl: string
- 9: string
- 96: string
- container: { lg: string; md: string; sm: string; xl: string }
  - lg: string
  - md: string
  - sm: string
  - xl: string
- full: string
- lg: string
- max: string
- md: string
- min: string
- px: string
- sm: string
- xl: string
- xs: string
space: { 0.5: string; 1: string; 1.5: string; 10: string; 12: string; 14: string; 16: string; 2: string; 2.5: string; 20: string; 24: string; 28: string; 3: string; 3.5: string; 32: string; 36: string; 4: string; 40: string; 44: string; 48: string; 5: string; 52: string; 56: string; 6: string; 60: string; 64: string; 7: string; 72: string; 8: string; 80: string; 9: string; 96: string; px: string }
- 0.5: string
- 1: string
- 1.5: string
- 10: string
- 12: string
- 14: string
- 16: string
- 2: string
- 2.5: string
- 20: string
- 24: string
- 28: string
- 3: string
- 3.5: string
- 32: string
- 36: string
- 4: string
- 40: string
- 44: string
- 48: string
- 5: string
- 52: string
- 56: string
- 6: string
- 60: string
- 64: string
- 7: string
- 72: string
- 8: string
- 80: string
- 9: string
- 96: string
- px: string
styles: Styles
transition: { duration: { fast: string; faster: string; normal: string; slow: string; slower: string; ultra-fast: string; ultra-slow: string }; easing: { ease-in: string; ease-in-out: string; ease-out: string }; property: { background: string; colors: string; common: string; dimensions: string; position: string } }
- duration: { fast: string; faster: string; normal: string; slow: string; slower: string; ultra-fast: string; ultra-slow: string }
  - fast: string
  - faster: string
  - normal: string
  - slow: string
  - slower: string
  - ultra-fast: string
  - ultra-slow: string
- easing: { ease-in: string; ease-in-out: string; ease-out: string }
  - ease-in: string
  - ease-in-out: string
  - ease-out: string
- property: { background: string; colors: string; common: string; dimensions: string; position: string }
  - background: string
  - colors: string
  - common: string
  - dimensions: string
  - position: string
zIndices: { auto: string; banner: number; base: number; docked: number; dropdown: number; hide: number; modal: number; overlay: number; popover: number; skipLink: number; sticky: number; toast: number; tooltip: number }
- auto: string
- banner: number
- base: number
- docked: number
- dropdown: number
- hide: number
- modal: number
- overlay: number
- popover: number
- skipLink: number
- sticky: number
- toast: number
- tooltip: number

Const localStorageProvider

localStorageProvider: LocalStorage = ...

Const locationSearchProvider

locationSearchProvider: LocationSearch = ...

Const pushError

pushError: Event<{ errorText: string; widgetName?: string }> = ...

Functions

Arr

Arr<T>(__namedParameters: ArrProps<T>): JSX.Element

- Defined in src/django-spa/components/Forms/Arr.tsx:6
Type Parameters
- T
Parameters
- __namedParameters: ArrProps<T>
Returns JSX.Element

AsyncDualSelectWidget

AsyncDualSelectWidget(props: DualSelectWidgetProps): Element

- Defined in src/common/components/AsyncDualSelectWidget/AsyncDualSelectWidget.tsx:45
Parameters
- props: DualSelectWidgetProps
Returns Element

AsyncReadOnlyWidget

AsyncReadOnlyWidget(props: WidgetProps): Element

- Defined in src/DetailView/widgets/AsyncReadOnlyWidget.tsx:20
Render data as text block with props.style and props.helpText Async load "data" from props.dataSource and then get content via props.displayValue if exists else get "data"[props.name].

Parameters
- props: WidgetProps
  
  standard widget props
Returns Element

AsyncSelectWidget

AsyncSelectWidget(__namedParameters: AsyncSelectWidgetProps): Element

- Defined in src/common/components/AsyncSelectWidget.tsx:53
Create select component with async loading options filtered by input text

Parameters
- __namedParameters: AsyncSelectWidgetProps
Returns Element

AvatarWidget

AvatarWidget(props: AvatarWidgetProps): Element

- Defined in src/DetailView/widgets/AvatarWidget.tsx:24
Render initials "BD" styled like avatar image

Parameters
- props: AvatarWidgetProps
Returns Element

BaseFilter

BaseFilter(__namedParameters: FilterProps): Element

- Defined in src/ListView/components/Table/filters.tsx:96
Parameters
- __namedParameters: FilterProps
Returns Element

BooleanFilter

BooleanFilter(params: BooleanFilterProps): Element

- Defined in src/ListView/components/Table/filters.tsx:253
Parameters
- params: BooleanFilterProps
Returns Element

Button

Button(props: ButtonProps): Element

- Defined in src/django-spa/cdk/Controls/Button/Button.tsx:8
Parameters
- props: ButtonProps
Returns Element

ButtonGroup

ButtonGroup<T>(__namedParameters: ButtonGroupProps<T>): JSX.Element

- Defined in src/django-spa/components/controls/ButtonGroup/ButtonGroup.tsx:4
Type Parameters
- T
Parameters
- __namedParameters: ButtonGroupProps<T>
Returns JSX.Element

CheckBoxGroup

CheckBoxGroup<T>(props: ControlProps<T[]> & { defaultValue?: string[]; getKey: any; getLabel: any; getValue: any } & { ref?: ForwardedRef<HTMLDivElement> }): Element

- Defined in src/django-spa/components/controls/CheckBoxGroup/CheckBoxGroup.tsx:51
Type Parameters
- T extends object
Parameters
- props: ControlProps<T[]> & { defaultValue?: string[]; getKey: any; getLabel: any; getValue: any } & { ref?: ForwardedRef<HTMLDivElement> }
Returns Element

CheckboxWidget

CheckboxWidget(props: { activeWizardRef?: MutableRefObject<null | WizardControl>; allowAllDefinedValues?: Accessor<boolean>; analytics?: BaseAnalytic; blockingValidators?: ValidatorFunction[]; cacheTime?: Accessor<number>; className?: string; containerErrorsStore?: Store<ErrorElement[]>; containerProps?: BoxProps; containerStore: Store<object>; copyValue?: GenericAccessor; dataSource: GenericAccessor; dataTarget: GenericAccessor; description?: string | Element; displayValue?: GenericAccessor; helpText?: string; labelContainerProps?: BoxProps; mainDetailObject: DetailObject; name: string; notBlockingValidators?: ValidatorFunction[]; notifier: BaseNotifier; provider: Provider; required?: Accessor<boolean>; resource: string; setInitialValue: Function; setMainDetailObject: Function; style?: CSSProperties; submitChange: Function; targetPayload: Function; useClipboard?: boolean; viewType: string; widgetAnalytics?: boolean | Function; widgetClassName?: string } & Omit<TestIdGenerationProps, "name"> & { isDisabled?: Accessor<boolean>; isReadOnly?: Accessor<boolean> }): Element

- Defined in src/DetailView/widgets/CheckboxWidget.tsx:20
Render input-checkbox for using in forms Load "value" from props.dataSource and then get content via props.displayValue if exists else get 'data'[props.name].

Parameters
- props: { activeWizardRef?: MutableRefObject<null | WizardControl>; allowAllDefinedValues?: Accessor<boolean>; analytics?: BaseAnalytic; blockingValidators?: ValidatorFunction[]; cacheTime?: Accessor<number>; className?: string; containerErrorsStore?: Store<ErrorElement[]>; containerProps?: BoxProps; containerStore: Store<object>; copyValue?: GenericAccessor; dataSource: GenericAccessor; dataTarget: GenericAccessor; description?: string | Element; displayValue?: GenericAccessor; helpText?: string; labelContainerProps?: BoxProps; mainDetailObject: DetailObject; name: string; notBlockingValidators?: ValidatorFunction[]; notifier: BaseNotifier; provider: Provider; required?: Accessor<boolean>; resource: string; setInitialValue: Function; setMainDetailObject: Function; style?: CSSProperties; submitChange: Function; targetPayload: Function; useClipboard?: boolean; viewType: string; widgetAnalytics?: boolean | Function; widgetClassName?: string } & Omit<TestIdGenerationProps, "name"> & { isDisabled?: Accessor<boolean>; isReadOnly?: Accessor<boolean> }
  
  widget props
Returns Element

CodeWidget

CodeWidget(props: WidgetProps): Element

- Defined in src/DetailView/widgets/CodeWidget.tsx:24
Parameters
- props: WidgetProps
Returns Element

ColumnsHider

ColumnsHider<T>(__namedParameters: ColumnHiderProps<T>): JSX.Element

- Defined in src/FormControls/ColumnHiding/ColumnsHider.tsx:17
Type Parameters
- T
Parameters
- __namedParameters: ColumnHiderProps<T>
Returns JSX.Element

ConfigProvider

ConfigProvider<GlobalConfig>(__namedParameters: ConfigProviderProps<GlobalConfig>): ReactElement<any, string | JSXElementConstructor<any>>

- Defined in src/data-provider/config-provider/ConfigProvider.tsx:18
Type Parameters
- GlobalConfig extends BaseConfig
Parameters
- __namedParameters: ConfigProviderProps<GlobalConfig>
Returns ReactElement<any, string | JSXElementConstructor<any>>

ContainerWidget

ContainerWidget(props: any): Element

- Defined in src/DetailView/widgets/ContainerWidget.tsx:17
Render props.widgets in data-grid by their layout-properties props.widgets: DetailFieldDescription[]

Parameters
- props: any
  
  widget props
Returns Element

DateFilter

DateFilter(params: DateTimeFilterProps): Element

- Defined in src/ListView/components/Table/filters.tsx:365
Parameters
- params: DateTimeFilterProps
Returns Element

DateTimeFilter

DateTimeFilter(params: DateTimeFilterProps): Element

- Defined in src/ListView/components/Table/filters.tsx:400
Parameters
- params: DateTimeFilterProps
Returns Element

DateTimeRangeListWidget

DateTimeRangeListWidget(props: DateTimeRangeWidgetProps): Element

- Defined in src/DetailView/widgets/DateTimeRangeListWidget.tsx:114
Render list of datetime range widgets. Suppose to use for schedule modify.

Waits for data type: [string, string][] , where string - ISO Date

props.oneDayInterval: boolean - restrict date range to one day length

Parameters
- props: DateTimeRangeWidgetProps
  
  widget props
Returns Element

DateTimeRangeWidget

DateTimeRangeWidget(props: DateTimeRangeWidgetProps): Element

- Defined in src/DetailView/widgets/DateTimeRangeWidget.tsx:34
Render date-range picker Waits for data type: [string, string], where string - ISO Date

props.oneDayInterval: boolean - restrict date range to one day length

Parameters
- props: DateTimeRangeWidgetProps
  
  widget props
Returns Element

DateTimeWidget

DateTimeWidget(props: DateTimeWidgetProps): Element

- Defined in src/DetailView/widgets/DateTimeWidget.tsx:39
Parameters
- props: DateTimeWidgetProps
Returns Element

DateWidget

DateWidget(props: DateWidgetProps): Element

- Defined in src/DetailView/widgets/DateWidget.tsx:37
Render date picker

Parameters
- props: DateWidgetProps
  
  widget props
Returns Element

DebounceInput

DebounceInput(props: ControlProps<string> & { debounceTimeout?: number; element?: FC<unknown> } & { ref?: ForwardedRef<HTMLInputElement> }): Element

- Defined in src/django-spa/components/controls/DebounceInput/DebounceInput.tsx:20
Parameters
- props: ControlProps<string> & { debounceTimeout?: number; element?: FC<unknown> } & { ref?: ForwardedRef<HTMLInputElement> }
Returns Element

EmailChipInputWidget

EmailChipInputWidget(props: EmailChipInputWidgetProps): Element

- Defined in src/DetailView/widgets/EmailChipInputWidget.tsx:18
Parameters
- props: EmailChipInputWidgetProps
Returns Element

EmptyFilter

EmptyFilter(props: { children: SlotElements<string> }): Element

- Defined in src/Layouts/EmptyFilter.tsx:4
Parameters
- props: { children: SlotElements<string> }
  - children: SlotElements<string>
Returns Element

Field

Field<T, P>(props: PropsWithDefaultLayout<FieldProps<T, P>, { Control: Element }>): Element

- Defined in src/django-spa/components/Forms/Field.tsx:9
Type Parameters
- T
- P extends ControlProps<T, P>
Parameters
- props: PropsWithDefaultLayout<FieldProps<T, P>, { Control: Element }>
Returns Element

FieldsBuilder

FieldsBuilder(props: PropsWithDefaultLayout<BaseFieldsBuilderProps, [key: string | number, element: Element][]>): Element

- Defined in src/django-spa/components/Forms/index.ts:15
Parameters
- props: PropsWithDefaultLayout<BaseFieldsBuilderProps, [key: string | number, element: Element][]>
Returns Element

FilesList

FilesList(__namedParameters: FilesListProps): ReactElement<FilesListProps>

- Defined in src/Widgets/FilesList/FilesList.tsx:9
Parameters
- __namedParameters: FilesListProps
Returns ReactElement<FilesListProps>

FilesUpload

FilesUpload(__namedParameters: FilesUploadProps): ReactElement<FilesUploadProps>

- Defined in src/FormControls/FilesUpload/FilesUpload.tsx:9
Parameters
- __namedParameters: FilesUploadProps
Returns ReactElement<FilesUploadProps>

ForeignKeySelectFilter

ForeignKeySelectFilter(params: ForeignKeySelectFilterProps): Element

- Defined in src/ListView/components/Table/filters.tsx:298
Parameters
- params: ForeignKeySelectFilterProps
Returns Element

ForeignKeySelectWidget

ForeignKeySelectWidget(props: ForeignKeySelectWidgetProps): Element

- Defined in src/DetailView/widgets/ForeignKeySelect.tsx:53
Render select-input with async loaded options from backend onChange - can return full loaded model for option, not just key

Based on AsyncSelectWidget, so have common props.

props.optionLabel - got loaded model and return label for option props.optionValue - got loaded model and return label for value props.targetPayload - got selected model and return widget payload props.styles - react-select styles props.optionLabelMenu - got loaded model and return menu label for option props.optionLabelValue - got loaded model and return value label for option

Parameters
- props: ForeignKeySelectWidgetProps
  
  widget props
Returns Element

Form

Form<K, T>(__namedParameters: PropsWithChildren<FormProps<K, T>>): JSX.Element

- Defined in src/django-spa/components/Forms/Form.tsx:6
Type Parameters
- K extends FieldKey
- T
Parameters
- __namedParameters: PropsWithChildren<FormProps<K, T>>
Returns JSX.Element

Full

Full(props: { children: SlotElements<"Label" | "Control" | "Errors"> }): Element

- Defined in src/django-spa/components/Forms/Layouts/Full.tsx:5
Parameters
- props: { children: SlotElements<"Label" | "Control" | "Errors"> }
  - children: SlotElements<"Label" | "Control" | "Errors">
Returns Element

Group

Group(__namedParameters: GroupProps): JSX.Element

- Defined in src/django-spa/components/Forms/Group.tsx:6
Parameters
- __namedParameters: GroupProps
Returns JSX.Element

HiddenAdditionalFilter

HiddenAdditionalFilter(props: { children: SlotElements<"main" | "buttons" | "additional"> }): Element

- Defined in src/Layouts/HiddenAdditionalFilter.tsx:36
Parameters
- props: { children: SlotElements<"main" | "buttons" | "additional"> }
  - children: SlotElements<"main" | "buttons" | "additional">
Returns Element

HiddenAdditionalFilterWithResults

HiddenAdditionalFilterWithResults(props: { children: SlotElements<"main" | "results" | "buttons" | "additional"> }): Element

- Defined in src/Layouts/HiddenAdditionalFilter.tsx:54
Parameters
- props: { children: SlotElements<"main" | "results" | "buttons" | "additional"> }
  - children: SlotElements<"main" | "results" | "buttons" | "additional">
Returns Element

Label

Label(__namedParameters: LabelProps): Element

- Defined in src/common/components/Label.tsx:10
Parameters
- __namedParameters: LabelProps
Returns Element

LinkWidget

LinkWidget(props: LinkWidgetProps): Element

- Defined in src/DetailView/widgets/LinkWidget.tsx:21
Parameters
- props: LinkWidgetProps
Returns Element

ListData

ListData<DataProps>(__namedParameters: ListDataProps<DataProps>): JSX.Element

- Defined in src/django-spa/components/integrators/ListView/ListData.ts:12
Полиморфный компонент для подключения вывода данных к ListView

remarks
Требования к компоненту вывода данных - {@link RequiredDataProps}

Type Parameters
- DataProps extends RequiredDataProps
Parameters
- __namedParameters: ListDataProps<DataProps>
Returns JSX.Element

ListFilters

ListFilters<FiltersProps>(__namedParameters: ListFiltersProps<FiltersProps>): JSX.Element

- Defined in src/django-spa/components/integrators/ListView/ListFilters.ts:6
Type Parameters
- FiltersProps extends RequiredFiltersProps
Parameters
- __namedParameters: ListFiltersProps<FiltersProps>
Returns JSX.Element

ListHorizontal

ListHorizontal(props: { children: Item[] }): Element

- Defined in src/Layouts/ListHorizontal.tsx:5
Parameters
- props: { children: Item[] }
  - children: Item[]
Returns Element

ListOrder

ListOrder<OrderProps>(__namedParameters: ListOrderProps<OrderProps>): JSX.Element

- Defined in src/django-spa/components/integrators/ListView/ListOrder.ts:12
Полиморфный компонент для подключения отдельного компонента сортировки к ListView

remarks
Требования к компоненту сортировки - {@link RequiredOrderProps}

Type Parameters
- OrderProps extends RequiredOrderProps
Parameters
- __namedParameters: ListOrderProps<OrderProps>
Returns JSX.Element

ListOrderedData

ListOrderedData<OrderedDataProps>(__namedParameters: ListOrderedDataProps<OrderedDataProps>): JSX.Element

- Defined in src/django-spa/components/integrators/ListView/ListOrderedData.ts:12
Полиморфный компонент для подключения вывода данных к ListView c поддержкой сортировки

remarks
Требования к компоненту вывода данных - {@link RequiredOrderedDataProps}

Type Parameters
- OrderedDataProps extends RequiredOrderedDataProps
Parameters
- __namedParameters: ListOrderedDataProps<OrderedDataProps>
Returns JSX.Element

ListPagination

ListPagination<PaginationProps>(__namedParameters: ListPaginationProps<PaginationProps>): JSX.Element

- Defined in src/django-spa/components/integrators/ListView/ListPagination.ts:12
Полиморфный компонент для подключения пагинации к ListView

remarks
Требования к компоненту пагинации - {@link RequiredPaginationProps}

Type Parameters
- PaginationProps extends RequiredPaginationProps
Parameters
- __namedParameters: ListPaginationProps<PaginationProps>
Returns JSX.Element

ListRaw

ListRaw(__namedParameters: ListRawProps): JSX.Element

- Defined in src/django-spa/components/integrators/ListView/ListRaw.ts:8
Компонент для кастомизации стандартного функционала ListView. Используя render-props в children с пробросом всего состояния ListView в качестве параметров, позволяет реализовывать любую непредусмотренную логику.

Parameters
- __namedParameters: ListRawProps
Returns JSX.Element

ListVertical

ListVertical(props: { children: Item[] }): Element

- Defined in src/Layouts/ListVertical.tsx:6
Parameters
- props: { children: Item[] }
  - children: Item[]
Returns Element

ListView

ListView(__namedParameters: PropsWithChildren<ListViewProps>): JSX.Element

- Defined in src/django-spa/components/integrators/ListView/ListView.tsx:15
Корневой компонент для отображения списков/таблиц/etc. различных сущностей. Через него задаётся контекст, которым пользуются остальные компоненты пакета

Parameters
- __namedParameters: PropsWithChildren<ListViewProps>
Returns JSX.Element

MaskFilter

MaskFilter(params: FilterProps & Props): Element

- Defined in src/ListView/components/Table/filters.tsx:123
Parameters
- params: FilterProps & Props
Returns Element

MessagesBlock

MessagesBlock(__namedParameters: { iconType?: MessageType; messageProps?: BoxProps; messageTextProps?: TextProps; messageType: MessageType; messages: undefined | (string | Element)[] }): Element

- Defined in src/common/components/MessagesBlock.tsx:23
Parameters
- __namedParameters: { iconType?: MessageType; messageProps?: BoxProps; messageTextProps?: TextProps; messageType: MessageType; messages: undefined | (string | Element)[] }
  - Optional iconType?: MessageType
  - Optional messageProps?: BoxProps
  - Optional messageTextProps?: TextProps
  - messageType: MessageType
  - messages: undefined | (string | Element)[]
Returns Element

MultiSelectFilter

MultiSelectFilter(params: ResourceFilterProps): Element

- Defined in src/ListView/components/Table/filters.tsx:161
Parameters
- params: ResourceFilterProps
Returns Element

MultiSelectWidget

MultiSelectWidget(props: MultiSelectWidgetProps): Element

- Defined in src/DetailView/widgets/MultiSelectWidget.tsx:29
Parameters
- props: MultiSelectWidgetProps
Returns Element

Order

Order(__namedParameters: OrderProps): ReactElement<OrderProps>

- Defined in src/FormControls/Ordering/Order.tsx:7
Parameters
- __namedParameters: OrderProps
Returns ReactElement<OrderProps>

PageList

PageList(props: { children: SlotElements<"data" | "filters" | "pagination"> }): Element

- Defined in src/django-spa/layouts/Pages/Body/PageList.tsx:8
Макет основного содержимого для страниц-списков с поддержкой фильтрации и пагинации

Parameters
- props: { children: SlotElements<"data" | "filters" | "pagination"> }
  - children: SlotElements<"data" | "filters" | "pagination">
Returns Element

PageM1xA4

PageM1xA4(props: { children: SlotElements<"T1" | "T2" | "M" | "B1" | "B2"> }): Element

- Defined in src/Layouts/PageM1xA4.tsx:5
Parameters
- props: { children: SlotElements<"T1" | "T2" | "M" | "B1" | "B2"> }
  - children: SlotElements<"T1" | "T2" | "M" | "B1" | "B2">
Returns Element

Pagination

Pagination(props: PropsWithDefaultLayout<PaginationProps, { Pages: string; ToFirst: Element; ToLast: Element; ToNext: Element; ToPrev: Element }>): Element

- Defined in src/FormControls/Pagination/Pagination.tsx:30
Parameters
- props: PropsWithDefaultLayout<PaginationProps, { Pages: string; ToFirst: Element; ToLast: Element; ToNext: Element; ToPrev: Element }>
Returns Element

PhoneChipInputWidget

PhoneChipInputWidget(props: PhoneChipInputWidgetProps): Element

- Defined in src/DetailView/widgets/PhoneChipInputWidget.tsx:18
Parameters
- props: PhoneChipInputWidgetProps
Returns Element

RadioButtonWidget

RadioButtonWidget(props: RadioButtonWidgetProps): Element

- Defined in src/DetailView/widgets/RadioButtonWidget.tsx:29
Parameters
- props: RadioButtonWidgetProps
Returns Element

RadioGroup

RadioGroup<T>(props: ControlProps<undefined | T> & { items: T[]; getKey: any; getLabel: any; getValue: any } & { ref?: ForwardedRef<HTMLDivElement> }): Element

- Defined in src/django-spa/components/controls/RadioGroup/RadioGroup.tsx:49
Type Parameters
- T extends object
Parameters
- props: ControlProps<undefined | T> & { items: T[]; getKey: any; getLabel: any; getValue: any } & { ref?: ForwardedRef<HTMLDivElement> }
Returns Element

ReadOnlyWidget

ReadOnlyWidget(props: ReadOnlyWidgetProps): Element

- Defined in src/DetailView/widgets/ReadOnlyWidget.tsx:21
Parameters
- props: ReadOnlyWidgetProps
Returns Element

RenderDetail

RenderDetail(props: RenderDetailProps): Element

- Defined in src/DetailView/RenderDetail.tsx:51
Parameters
- props: RenderDetailProps
Returns Element

ResourceProvider

ResourceProvider(__namedParameters: ResourceConfigProviderProps): ReactElement<any, string | JSXElementConstructor<any>>

- Defined in src/data-provider/resource-provider/ResourceProvider.tsx:19
Parameters
- __namedParameters: ResourceConfigProviderProps
Returns ReactElement<any, string | JSXElementConstructor<any>>

RowWidget

RowWidget(props: RowWidgetProps): Element

- Defined in src/DetailView/widgets/RowWidget.tsx:16
Parameters
- props: RowWidgetProps
Returns Element

Select

Select<OptionType, IsMulti>(__namedParameters: SelectProps<OptionType, IsMulti, GroupTypeBase<OptionType>>): Element

- Defined in src/common/components/Select.tsx:7
Type Parameters
- OptionType extends OptionTypeBase = { label: string; value: string }
- IsMulti extends boolean = false
Parameters
- __namedParameters: SelectProps<OptionType, IsMulti, GroupTypeBase<OptionType>>
Returns Element

SelectFilter

SelectFilter(params: ResourceFilterProps): Element

- Defined in src/ListView/components/Table/filters.tsx:216
Parameters
- params: ResourceFilterProps
Returns Element

SideBarElementCompatible

SideBarElementCompatible(__namedParameters: SideBarElementProps): JSX.Element

- Defined in src/LegacySupport/SideBarElementCompatible.tsx:6
Parameters
- __namedParameters: SideBarElementProps
Returns JSX.Element

StatefullAsyncSelect

StatefullAsyncSelect<OptionType>(__namedParameters: StatefullAsyncSelecProps<OptionType, number, false>): ReactElement<any, string | JSXElementConstructor<any>>

- Defined in src/django-spa/smart-components/StatefulAsyncSelect.tsx:39
Type Parameters
- OptionType extends OptionTypeBase
Parameters
- __namedParameters: StatefullAsyncSelecProps<OptionType, number, false>
Returns ReactElement<any, string | JSXElementConstructor<any>>

StyledTable

StyledTable<T>(props: TableProps<T>): ReactElement<any, string | JSXElementConstructor<any>>

- Defined in src/Widgets/Table/TableOld.tsx:4
Type Parameters
- T
Parameters
- props: TableProps<T>
Returns ReactElement<any, string | JSXElementConstructor<any>>

SwitchWidget

SwitchWidget(props: WidgetProps): Element

- Defined in src/DetailView/widgets/SwitchWidget.tsx:20
Render input-switch for using in forms Load "value" from props.dataSource and then get content via props.displayValue if exists else get 'data'[props.name].

Parameters
- props: WidgetProps
  
  widget props
Returns Element

Table

Table(__namedParameters: TableProps): Element

- Defined in src/ListView/components/Table/index.tsx:112
Parameters
- __namedParameters: TableProps
Returns Element

TextEditorWidget

TextEditorWidget(props: TextEditorProps): Element

- Defined in src/DetailView/widgets/TextEditorWidget.tsx:18
Parameters
- props: TextEditorProps
Returns Element

TextValidationWidget

TextValidationWidget(props: { activeWizardRef?: MutableRefObject<null | WizardControl>; allowAllDefinedValues?: Accessor<boolean>; analytics?: BaseAnalytic; blockingValidators?: ValidatorFunction[]; cacheTime?: Accessor<number>; className?: string; containerErrorsStore?: Store<ErrorElement[]>; containerProps?: BoxProps; containerStore: Store<object>; copyValue?: GenericAccessor; dataSource: GenericAccessor; dataTarget: GenericAccessor; description?: string | Element; displayValue?: GenericAccessor; helpText?: string; labelContainerProps?: BoxProps; mainDetailObject: DetailObject; name: string; notBlockingValidators?: ValidatorFunction[]; notifier: BaseNotifier; provider: Provider; required?: Accessor<boolean>; resource: string; setInitialValue: Function; setMainDetailObject: Function; style?: CSSProperties; submitChange: Function; targetPayload: Function; useClipboard?: boolean; viewType: string; widgetAnalytics?: boolean | Function; widgetClassName?: string } & Omit<TestIdGenerationProps, "name"> & { validateValue?: any }): Element

- Defined in src/DetailView/widgets/TextValidationWidget.tsx:14
Parameters
- props: { activeWizardRef?: MutableRefObject<null | WizardControl>; allowAllDefinedValues?: Accessor<boolean>; analytics?: BaseAnalytic; blockingValidators?: ValidatorFunction[]; cacheTime?: Accessor<number>; className?: string; containerErrorsStore?: Store<ErrorElement[]>; containerProps?: BoxProps; containerStore: Store<object>; copyValue?: GenericAccessor; dataSource: GenericAccessor; dataTarget: GenericAccessor; description?: string | Element; displayValue?: GenericAccessor; helpText?: string; labelContainerProps?: BoxProps; mainDetailObject: DetailObject; name: string; notBlockingValidators?: ValidatorFunction[]; notifier: BaseNotifier; provider: Provider; required?: Accessor<boolean>; resource: string; setInitialValue: Function; setMainDetailObject: Function; style?: CSSProperties; submitChange: Function; targetPayload: Function; useClipboard?: boolean; viewType: string; widgetAnalytics?: boolean | Function; widgetClassName?: string } & Omit<TestIdGenerationProps, "name"> & { validateValue?: any }
Returns Element

ThemeProvider

ThemeProvider(__namedParameters: ThemeProviderProps): Element

- Defined in src/styles/ThemeProvider.tsx:39
Parameters
- __namedParameters: ThemeProviderProps
Returns Element

ToClipboard

ToClipboard(__namedParameters: ToClipboardProps): Element

- Defined in src/common/components/ToClipboard.tsx:14
Parameters
- __namedParameters: ToClipboardProps
Returns Element

UpdatedFilters

UpdatedFilters<K>(__namedParameters: FiltersProps<K, any>): ReactElement<FiltersProps<K, any>>

- Defined in src/Widgets/Filters/Filters.tsx:13
Type Parameters
- K extends string
Parameters
- __namedParameters: FiltersProps<K, any>
Returns ReactElement<FiltersProps<K, any>>

UpdatedWizard

UpdatedWizard<Key, Action, StepData>(props: WizardProps<Key, Action, StepData>): Element

- Defined in src/Wizard/Wizard.tsx:7
Type Parameters
- Key extends string
- Action extends string
- StepData extends object
Parameters
- props: WizardProps<Key, Action, StepData>
Returns Element

WhereFilters

WhereFilters<FiltersProps>(__namedParameters: WhereFiltersProps<FiltersProps>): JSX.Element

- Defined in src/django-spa/components/integrators/WherePanel/WhereFilters.ts:10
Полиморфный компонент-обёртка для компонентов с контролами фильтров

Type Parameters
- FiltersProps extends RequiredFiltersProps
Parameters
- __namedParameters: WhereFiltersProps<FiltersProps>
Returns JSX.Element

WherePanel

WherePanel<K>(__namedParameters: WhereProviderProps<K>): JSX.Element

- Defined in src/django-spa/components/integrators/WherePanel/WherePanel.ts:3
Type Parameters
- K extends string
Parameters
- __namedParameters: WhereProviderProps<K>
Returns JSX.Element

WherePredefined

WherePredefined<FiltersProps>(__namedParameters: WherePredefinedProps<FiltersProps>): JSX.Element

- Defined in src/django-spa/components/integrators/WherePanel/WherePredefined.ts:11
Полиморфный компонент-обёртка для компонентов выбора набора предустановленных фильтров

Type Parameters
- FiltersProps extends RequiredPredefinedProps
Parameters
- __namedParameters: WherePredefinedProps<FiltersProps>
Returns JSX.Element

WithError

WithError(props: { children: SlotElements<"Control" | "Errors"> }): Element

- Defined in src/django-spa/components/Forms/Layouts/WithError.tsx:5
Parameters
- props: { children: SlotElements<"Control" | "Errors"> }
  - children: SlotElements<"Control" | "Errors">
Returns Element

combine

combine(validatorsWithLevel: { level: number; validator: Validator }[]): LeveledValidator

- Defined in src/django-spa/cdk/Validation/Combine.ts:10
Parameters
- validatorsWithLevel: { level: number; validator: Validator }[]
Returns LeveledValidator

convertZod

convertZod(schema: ZodType): Validator

- Defined in src/django-spa/cdk/Validation/Zod.ts:11
Parameters
- schema: ZodType
Returns Validator

convertZodRecord

convertZodRecord(schema: ZodType, level: number): RecordValidator

- Defined in src/django-spa/cdk/Validation/Zod.ts:19
Parameters
- schema: ZodType
- level: number
Returns RecordValidator

entitiesList

entitiesList<Entity, ExtFilters, ErrorType>(filtersComponent: FiltersComponent<Omit<ExtFilters, "page" | "ordering">>, listComponent: ListComponent<Entity>, paginationComponent: PaginationComponent, options: null | EntitiesListConfig<ExtFilters, ErrorType>, __namedParameters: EntitiesListProps<Entity, ExtFilters>): { filters: ReactElement; list: ReactElement; pagination: ReactElement }

- Defined in src/features/EntitiesList/EntitiesList.ts:6
Type Parameters
- Entity
- ExtFilters extends { ordering?: string; page?: number; per_page?: number }
- ErrorType = Error
Parameters
- filtersComponent: FiltersComponent<Omit<ExtFilters, "page" | "ordering">>
- listComponent: ListComponent<Entity>
- paginationComponent: PaginationComponent
- options: null | EntitiesListConfig<ExtFilters, ErrorType>
- __namedParameters: EntitiesListProps<Entity, ExtFilters>
Returns { filters: ReactElement; list: ReactElement; pagination: ReactElement }
- filters: ReactElement
- list: ReactElement
- pagination: ReactElement

entitiesPage

entitiesPage<Entity, Filters>(entitiesListFeature: EntitiesListFeature<Entity, Partial<Filters>>, defaultFilters: Partial<Filters>, __namedParameters: EntitiesPageProps<Entity, Partial<Filters>>): { filters: ReactElement; list: ReactElement; pagination: ReactElement }

- Defined in src/features/EntitiesPage/EntitiesPage.ts:6
Type Parameters
- Entity
- Filters
Parameters
- entitiesListFeature: EntitiesListFeature<Entity, Partial<Filters>>
- defaultFilters: Partial<Filters>
- __namedParameters: EntitiesPageProps<Entity, Partial<Filters>>
Returns { filters: ReactElement; list: ReactElement; pagination: ReactElement }
- filters: ReactElement
- list: ReactElement
- pagination: ReactElement

getAccessor

getAccessor(handler: any, data?: DetailObject, context?: {}): any

- Defined in src/DetailView/utils/dataAccess.ts:16
Parameters
- handler: any
- Optional data: DetailObject
- context: {} = {}
Returns any

getAccessorWithDefault

getAccessorWithDefault(handler: any, data: DetailObject, context?: {}, defaultValue?: any): any

- Defined in src/DetailView/utils/dataAccess.ts:24
Parameters
- handler: any
- data: DetailObject
- context: {} = {}
- defaultValue: any = undefined
Returns any

getCopyHandler

getCopyHandler(value: null | { toString: Function }, copyValue?: GenericAccessor, fallbackCopyValue?: GenericAccessor): Function

- Defined in src/DetailView/utils/dataAccess.ts:68
Parameters
- value: null | { toString: Function }
- Optional copyValue: GenericAccessor
- Optional fallbackCopyValue: GenericAccessor
Returns Function

getData

getData(handler: GenericAccessor, data: DetailObject, context?: {}): any

- Defined in src/DetailView/utils/dataAccess.ts:4
Parameters
- handler: GenericAccessor
- data: DetailObject
- context: {} = {}
Returns any

getDefaultButtons

getDefaultButtons(wizardStep: BaseWizardStep): WizardStepButtonDescription[]

- Defined in src/WizardMaster/buttons.ts:47
Parameters
- wizardStep: BaseWizardStep
Returns WizardStepButtonDescription[]

getDefaultConfigProviderConfig

getDefaultConfigProviderConfig<Config>(): ConfigProcessorConfig<Config>

- Defined in src/data-provider/config-provider/utils/getDefaultConfigProviderConfig.ts:3
Type Parameters
- Config extends BaseConfig
Returns ConfigProcessorConfig<Config>

getDefaultResourceConfig

getDefaultResourceConfig(client: AxiosInstance): ResourceDefaultConfig<unknown>

- Defined in src/data-provider/resource-provider/utils/getDefaultResourceConfig.ts:9
Parameters
- client: AxiosInstance
Returns ResourceDefaultConfig<unknown>

getNextButton

getNextButton(wizardStep: BaseWizardStep, style?: Style, label?: string, name?: string): WizardStepButtonDescription

- Defined in src/WizardMaster/buttons.ts:31
Parameters
- wizardStep: BaseWizardStep
- Optional style: Style
- Optional label: string
- Optional name: string
Returns WizardStepButtonDescription

getPayload

getPayload(value: any, name: string, targetPayload: GenericAccessor): null | string | {}

- Defined in src/DetailView/utils/dataAccess.ts:56
Parameters
- value: any
- name: string
- targetPayload: GenericAccessor
Returns null | string | {}

getPrevButton

getPrevButton(wizardStep: BaseWizardStep, style?: Style, label?: string, name?: string): WizardStepButtonDescription

- Defined in src/WizardMaster/buttons.ts:16
Parameters
- wizardStep: BaseWizardStep
- Optional style: Style
- Optional label: string
- Optional name: string
Returns WizardStepButtonDescription

getWidgetContent

getWidgetContent(name: string, detailObject: DetailObject, handler: GenericAccessor, context?: {}, allowDefinedValues?: boolean): any

- Defined in src/DetailView/utils/dataAccess.ts:35
Parameters
- name: string
- detailObject: DetailObject
- handler: GenericAccessor
- context: {} = {}
- Optional allowDefinedValues: boolean
Returns any

handleUserAction

handleUserAction(actionHandlerArguments: ActionHandlerArguments): void

- Defined in src/common/utils/handleUserAction.ts:12
Parameters
- actionHandlerArguments: ActionHandlerArguments
Returns void

hasPermission

hasPermission(permissions: string[], requiredPerm: string): boolean

- Defined in src/common/permissions.ts:4
Parameters
- permissions: string[]
- requiredPerm: string
Returns boolean

isEqual

isEqual(a: any, b: any): boolean

- Defined in src/django-spa/utils/Types/IsEqual.ts:3
Parameters
- a: any
- b: any
Returns boolean

makeAsync

makeAsync<T>(base: SyncReadWriteProvider<T>): AsyncReadWriteProvider<T>

- Defined in src/django-spa/cdk/Providers/ReadWrite/Async.factory.ts:3
Type Parameters
- T
Parameters
- base: SyncReadWriteProvider<T>
Returns AsyncReadWriteProvider<T>

makeAsyncConverter

makeAsyncConverter<S, T>(base: AsyncReadWriteProvider<S>, converters: AsyncReadWriteConverters<S, T>): AsyncReadWriteProvider<T>

- Defined in src/django-spa/cdk/Providers/ReadWrite/AsyncConverter.factory.ts:3
Type Parameters
- S
- T
Parameters
- base: AsyncReadWriteProvider<S>
- converters: AsyncReadWriteConverters<S, T>
Returns AsyncReadWriteProvider<T>

makeByGetSet

makeByGetSet<T>(get: (() => readonly T[]), set: ((val: T[]) => void), calcPK: ((val: T) => string | number)): CRUDProvider<T>

- Defined in src/django-spa/cdk/Providers/CRUD/GetSet.factory.ts:3
Type Parameters
- T
Parameters
- get: (() => readonly T[])
  - - (): readonly T[]
    - Returns readonly T[]
- set: ((val: T[]) => void)
  - - (val: T[]): void
    - Parameters
      - val: T[]
      Returns void
- calcPK: ((val: T) => string | number)
  - - (val: T): string | number
    - Parameters
      - val: T
      Returns string | number
Returns CRUDProvider<T>

makeDefault

makeDefault<Props, Predefined>(source: ComponentType<Props>, predefined: Predefined): FC<Props & Predefined>

- Defined in src/django-spa/cdk/compatibility/makeDefault.ts:24
Создаёт компонент-обёртку с частично или полностью определёнными props исходного компонента в качестве значений по-умолчанию
remarks
Помогает быстро создавать компоненты, совместимые с каким-либо API.

example
Определяем foo, но не трогаем bar
```
// ComponentProps<SourceComponent> = { foo: unknown, bar: unknown }
const NewComponent = makePartial(SourceComponent, { foo: 'test' })
// Рендер <NewComponent bar={12} />
// эквивалентен <SourceComponent foo="test" bar={12} />
// но можно и <NewComponent bar={12} foo="other test" />
// эквивалентен <SourceComponent foo="other test" bar={12} />
```
Type Parameters
- Props extends {}
- Predefined extends Partial<Props>
Parameters
- source: ComponentType<Props>
  
  исходный компонент
- predefined: Predefined
  
  словарь с зафиксированными props
Returns FC<Props & Predefined>

makeEntitiesSource

makeEntitiesSource<Entity, Filters>(provider: Pick<Provider, "getPage">, url: string): EntitiesSource<Entity, Filters>

- Defined in src/django-spa/cdk/State/EntitiesSource.factory.ts:6
Type Parameters
- Entity
- Filters
Parameters
- provider: Pick<Provider, "getPage">
- url: string
Returns EntitiesSource<Entity, Filters>

makeFiltersConsumer

makeFiltersConsumer<K, ConsumerProps>(keys: K[], proxy?: ((data: ContextsData<Pick<{ filters: Context<FiltersContext> }, K>>) => ConsumerProps)): PolymorphComponent<ConsumerProps>

- Defined in src/django-spa/components/integrators/Filters/FiltersIntegrator.ts:22
Type Parameters
- K extends "filters"
- ConsumerProps = ContextsData<Pick<{ filters: Context<FiltersContext> }, K>>
Parameters
- keys: K[]
- Optional proxy: ((data: ContextsData<Pick<{ filters: Context<FiltersContext> }, K>>) => ConsumerProps)
  - - (data: ContextsData<Pick<{ filters: Context<FiltersContext> }, K>>): ConsumerProps
    - Parameters
      - data: ContextsData<Pick<{ filters: Context<FiltersContext> }, K>>
      Returns ConsumerProps
Returns PolymorphComponent<ConsumerProps>

makeList

makeList(Container: ComponentType<{}>, Item: ComponentType<{}>): LayoutComponent<Item[]>

- Defined in src/django-spa/cdk/Layouts/List.factory.tsx:5
Parameters
- Container: ComponentType<{}>
- Item: ComponentType<{}>
Returns LayoutComponent<Item[]>

makeListConsumer

makeListConsumer<K, ConsumerProps>(keys: K[], proxy?: ((data: ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; status: Context<Readonly<StatusContext>> }, K>>) => ConsumerProps)): PolymorphComponent<ConsumerProps>

- Defined in src/django-spa/components/integrators/Lists/ListIntegrator.ts:38
Фабричная функция для создания кастомных компонентов потребителей для интегратора ListIntegrator

Type Parameters
- K extends "data" | "params" | "status"
- ConsumerProps = ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; status: Context<Readonly<StatusContext>> }, K>>
Parameters
- keys: K[]
- Optional proxy: ((data: ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; status: Context<Readonly<StatusContext>> }, K>>) => ConsumerProps)
  - - (data: ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; status: Context<Readonly<StatusContext>> }, K>>): ConsumerProps
    - Parameters
      - data: ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; status: Context<Readonly<StatusContext>> }, K>>
      Returns ConsumerProps
Returns PolymorphComponent<ConsumerProps>

makeModelSource

makeModelSource<Model>(provider: AsyncReadWriteProvider<Model>, defaultValue: Model): ModelSource<Model>

- Defined in src/django-spa/cdk/State/ModelSource.factory.ts:6
Type Parameters
- Model
Parameters
- provider: AsyncReadWriteProvider<Model>
- defaultValue: Model
Returns ModelSource<Model>

makeNamespace

makeNamespace<T>(base: AsyncKeyValueProvider<string, T>, namespace: string): AsyncKeyValueProvider<string, T>
makeNamespace<T>(base: SyncKeyValueProvider<string, T>, namespace: string): SyncKeyValueProvider<string, T>

- Defined in src/django-spa/cdk/Providers/KeyValue/Namespace.factory.ts:3
Type Parameters
- T
Parameters
- base: AsyncKeyValueProvider<string, T>
- namespace: string
Returns AsyncKeyValueProvider<string, T>
- Defined in src/django-spa/cdk/Providers/KeyValue/Namespace.factory.ts:7
Type Parameters
- T
Parameters
- base: SyncKeyValueProvider<string, T>
- namespace: string
Returns SyncKeyValueProvider<string, T>

makeOrderedTable

makeOrderedTable(table: TableComponent): OrderedTableComponent

- Defined in src/FormControls/Ordering/OrderedTable.factory.tsx:10
Parameters
- table: TableComponent
Returns OrderedTableComponent

makePartial

makePartial<Props, Predefined>(source: ComponentType<Props>, predefined: Predefined): FC<Omit<Props, keyof Predefined>>

- Defined in src/django-spa/cdk/compatibility/makePartial.ts:22
Создаёт компонент-обёртку с частично или полностью определёнными props исходного компонента
remarks
Помогает быстро создавать компоненты, совместимые с каким-либо API.

example
Определяем foo, но не трогаем bar
```
// ComponentProps<SourceComponent> = { foo: unknown, bar: unknown }
const NewComponent = makePartial(SourceComponent, { foo: 'test' })
// Рендер <NewComponent bar={12} />
// эквивалентен <SourceComponent foo="test" bar={12} />
```
Type Parameters
- Props extends {}
- Predefined extends Partial<Props>
Parameters
- source: ComponentType<Props>
  
  исходный компонент
- predefined: Predefined
  
  словарь с зафиксированными props
Returns FC<Omit<Props, keyof Predefined>>

makePropsKeyProxy

makePropsKeyProxy<SP, SK, TK>(source: FC<SP>, map: ReadonlyMap<SK, TK>): FC<Omit<SP, SK> & Record<TK, SP[SK]>>

- Defined in src/django-spa/cdk/compatibility/makePropsKeyProxy.ts:26
Создаёт компонент-обёртку, переименовывая часть или все props перед передачей в исходный
remarks
Помогает быстро создавать компоненты, совместимые с каким-либо API. Если дополнительно требуется преобразовывать и значение props, то можно совмещать с makePropsValueProxy.

example
Простое переименование ключа foo в bar
```
// ComponentProps<SourceComponent> = { foo: unknown }
const NewComponent = makePropsKeyProxy(SourceComponent, new Map([
 ['foo', 'bar']
]))
// ComponentProps<NewComponent> = { bar: unknown }
```
Type Parameters
- SP extends {}
- SK extends string | number | symbol
- TK extends string
Parameters
- source: FC<SP>
  
  исходный компонент
- map: ReadonlyMap<SK, TK>
  
  карта переименований вида (исходный ключ, новый ключ)
Returns FC<Omit<SP, SK> & Record<TK, SP[SK]>>

makePropsValueProxy

makePropsValueProxy<SP, SK, TV>(source: FC<SP>, map: ReadonlyMap<SK, ((val: unknown) => TV)>): FC<Omit<SP, SK> & Record<SK, TV>>

- Defined in src/django-spa/cdk/compatibility/makePropsValueProxy.ts:25
Создаёт компонент-обёртку, преобразующий часть или все значения props перед передачей в исходный
remarks
Помогает быстро создавать компоненты, совместимые с каким-либо API. Если дополнительно требуется преобразовывать и имена props, то можно совмещать с makePropsKeyProxy.

example
Пытаемся привести тип значения к строчному
```
const AnyTypeComponent = makePropsValueProxy(SourceComponent, new Map([
 ['foo', (val: unknown) => JSON.stringify(val)]
]))
// Рендер <AnyTypeComponent foo={12} />
// эквивалентен <SourceComponent foo={JSON.stringify(12)} />
```
Type Parameters
- SP extends {}
- SK extends string | number | symbol
- TV
Parameters
- source: FC<SP>
  
  исходный компонент
- map: ReadonlyMap<SK, ((val: unknown) => TV)>
  
  карта преобразований вида (ключ, функция-конвертер)
Returns FC<Omit<SP, SK> & Record<SK, TV>>

makeProxied

makeProxied<SourceChildren, TargetChildren>(layout: LayoutComponent<SourceChildren, {}>, mapping: ((targetChildren: TargetChildren) => SourceChildren)): LayoutComponent<TargetChildren>

- Defined in src/django-spa/cdk/Layouts/Proxy.factory.ts:3
Type Parameters
- SourceChildren
- TargetChildren
Parameters
- layout: LayoutComponent<SourceChildren, {}>
- mapping: ((targetChildren: TargetChildren) => SourceChildren)
  - - (targetChildren: TargetChildren): SourceChildren
    - Parameters
      - targetChildren: TargetChildren
      Returns SourceChildren
Returns LayoutComponent<TargetChildren>

makeSelectListConsumer

makeSelectListConsumer<K, ConsumerProps>(keys: K[], proxy?: ((data: ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; selected: Context<readonly [unknown[], ((selected: unknown[]) => void)]>; status: Context<Readonly<StatusContext>> }, K>>) => ConsumerProps)): PolymorphComponent<ConsumerProps>

- Defined in src/django-spa/components/integrators/Lists/SelectListIntegrator.ts:42
Type Parameters
- K extends "data" | "params" | "status" | "selected"
- ConsumerProps = ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; selected: Context<readonly [unknown[], ((selected: unknown[]) => void)]>; status: Context<Readonly<StatusContext>> }, K>>
Parameters
- keys: K[]
- Optional proxy: ((data: ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; selected: Context<readonly [unknown[], ((selected: unknown[]) => void)]>; status: Context<Readonly<StatusContext>> }, K>>) => ConsumerProps)
  - - (data: ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; selected: Context<readonly [unknown[], ((selected: unknown[]) => void)]>; status: Context<Readonly<StatusContext>> }, K>>): ConsumerProps
    - Parameters
      - data: ContextsData<Pick<{ data: Context<Readonly<DataContext>>; params: Context<readonly [Params, ((p: Params) => void)]>; selected: Context<readonly [unknown[], ((selected: unknown[]) => void)]>; status: Context<Readonly<StatusContext>> }, K>>
      Returns ConsumerProps
Returns PolymorphComponent<ConsumerProps>

makeSlots

makeSlots<K, Props>(mapping: ((elements: SlotElements<K>, props?: Props) => Element)): LayoutComponent<SlotElements<K>, Props>

- Defined in src/django-spa/cdk/Layouts/Slots.factory.ts:16
Функция для создания слотовых компонентов-макетов

remarks
Слотовый макет предоставляет несколько различных точек (слотов) для вывода переданных ему в children prop подкомпонентов.

remarks
Нет сложности в описание макетов, как обычных react-компонентов, но использование этой функции гарантирует единообразный API для них

Type Parameters
- K extends string
- Props = {}
Parameters
- mapping: ((elements: SlotElements<K>, props?: Props) => Element)
  
  функция, строящая итоговый элемент
  - - (elements: SlotElements<K>, props?: Props): Element
    - Parameters
      - elements: SlotElements<K>
      - Optional props: Props
      Returns Element
Returns LayoutComponent<SlotElements<K>, Props>

makeSyncConverter

makeSyncConverter<S, T>(base: SyncReadWriteProvider<S>, converters: SyncReadWriteConverters<S, T>): SyncReadWriteProvider<T>

- Defined in src/django-spa/cdk/Providers/ReadWrite/SyncConverter.factory.ts:3
Type Parameters
- S
- T
Parameters
- base: SyncReadWriteProvider<S>
- converters: SyncReadWriteConverters<S, T>
Returns SyncReadWriteProvider<T>

makeTableWithHidableColumns

makeTableWithHidableColumns(table: TableComponent): TableWithHidableColumnsComponent

- Defined in src/FormControls/ColumnHiding/TableWithHidableColumns.factory.tsx:17
Parameters
- table: TableComponent
Returns TableWithHidableColumnsComponent

makeUpdateWithNotification

makeUpdateWithNotification(provider: Provider, url: string, payload: object, setObject: Function, notifier: BaseNotifier): Promise<any>

- Defined in src/admin/providers/utils.ts:5
Parameters
- provider: Provider
- url: string
- payload: object
- setObject: Function
- notifier: BaseNotifier
Returns Promise<any>

makeWithLayout

makeWithLayout<P, R>(featureFunc: FeatureFunc<P, R>): Component<PropsWithLayout<P, R>>
makeWithLayout<P, R>(featureFunc: FeatureFunc<P, R>, defaultLayout: LayoutComponent<R, {}> | LayoutDescriptor<R>): Component<PropsWithDefaultLayout<P, R>>

- Defined in src/django-spa/cdk/Layouts/WithLayout.factory.ts:5
Type Parameters
- P
- R
Parameters
- featureFunc: FeatureFunc<P, R>
Returns Component<PropsWithLayout<P, R>>
- Defined in src/django-spa/cdk/Layouts/WithLayout.factory.ts:6
Type Parameters
- P
- R
Parameters
- featureFunc: FeatureFunc<P, R>
- defaultLayout: LayoutComponent<R, {}> | LayoutDescriptor<R>
Returns Component<PropsWithDefaultLayout<P, R>>

partial

partial<T, U, R>(func: ((...args: [...T[], ...U[]]) => R), ...headArgs: T): ((...tailArgs: U) => R)

- Defined in src/django-spa/utils/funcs/partial.ts:9
Создаёт функцию, вызывающую func c аргументами headArgs, перед переданным.

see
https://ru.wikipedia.org/wiki/Частичное_применение

Type Parameters
- T extends readonly any[]
- U extends readonly any[]
- R
Parameters
- func: ((...args: [...T[], ...U[]]) => R)
  
  исходная функция
  - - (...args: [...T[], ...U[]]): R
    - Parameters
      - Rest ...args: [...T[], ...U[]]
      Returns R
- Rest ...headArgs: T
  
  аргументы, с которыми будет вызываться func в в дополнение к переданным
Returns ((...tailArgs: U) => R)
- - (...tailArgs: U): R
  - Parameters
    - Rest ...tailArgs: U
    Returns R

pushAnalytics

pushAnalytics(params: WidgetAnalyticsParams): void

- Defined in src/integration/analytics/utils.ts:61
Parameters
- params: WidgetAnalyticsParams
Returns void

recordCombine

recordCombine<K>(recordValidators: Record<K, LeveledValidator>): RecordValidator

- Defined in src/django-spa/cdk/Validation/Combine.ts:35
Type Parameters
- K extends string
Parameters
- recordValidators: Record<K, LeveledValidator>
Returns RecordValidator

registerLocale

registerLocale(localeName: string, localeData: Locale): void

- Defined in node_modules/@types/react-datepicker/index.d.ts:30
Parameters
- localeName: string
- localeData: Locale
Returns void

setDefaultLocale

setDefaultLocale(localeName: string): void

- Defined in node_modules/@types/react-datepicker/index.d.ts:31
Parameters
- localeName: string
Returns void

useAccess

useAccess(user: User, resource: string, action: AccessActionType): AccessPayload

- Defined in src/django-spa/aspects/access/hooks.ts:8
Parameters
- user: User
- resource: string
- action: AccessActionType
Returns AccessPayload

useAnalytics

useAnalytics(): AnalyticsHandler

- Defined in src/django-spa/aspects/analytics/Analytics.context.ts:8
Returns AnalyticsHandler

useApiState

useApiState<T, Config>(initial: T, apiConfig: Config): [state: T, api: Api<T, Config>]

- Defined in src/django-spa/cdk/Hooks/Api.state.ts:3
Type Parameters
- T
- Config extends ApiConfig<T>
Parameters
- initial: T
- apiConfig: Config
Returns [state: T, api: Api<T, Config>]

useArray

useArray(...tailArgs: Arr): RootProviderDesc

- Defined in src/django-spa/cdk/Forms/Fields/index.ts:17
Parameters
- Rest ...tailArgs: Arr
Returns RootProviderDesc

useArrayValidation

useArrayValidation(...tailArgs: [value: unknown[], validator?: ArrayValidator]): UseArrayValidationResult

- Defined in src/django-spa/cdk/Forms/Validation/index.ts:18
Parameters
- Rest ...tailArgs: [value: unknown[], validator?: ArrayValidator]
Returns UseArrayValidationResult

useChangeEffect

useChangeEffect(callback: EffectCallback, deps?: DependencyList): void

- Defined in src/django-spa/cdk/Hooks/Change.effect.ts:3
Parameters
- callback: EffectCallback
- Optional deps: DependencyList
Returns void

useCombine

useCombine(validatorsWithLevel: { level: number; validator: Validator }[]): LeveledValidator

- Defined in src/django-spa/cdk/Validation/Combine.ts:5
Parameters
- validatorsWithLevel: { level: number; validator: Validator }[]
Returns LeveledValidator

useConfig

useConfig<Config>(optionsOrString: ConfigConsumerOptionsOrKey<Config>): Config

- Defined in src/data-provider/config-provider/hooks/useConfig.ts:6
Type Parameters
- Config extends BaseConfig
Parameters
- optionsOrString: ConfigConsumerOptionsOrKey<Config>
Returns Config

useConfigResolver

useConfigResolver<T>(config: string | T): T

- Defined in src/data-provider/hooks/useConfigResolver.ts:4
Type Parameters
- T extends { key: string }
Parameters
- config: string | T
Returns T

useConsoleLogger

useConsoleLogger(): LoggingHandler

- Defined in src/django-spa/aspects/logger/Logger.ts:7
Returns LoggingHandler

useCreateTestId

useCreateTestId(config?: TestIdGenerationProps): UseCreateTestIdResult

- Defined in src/django-spa/aspects/test-id/hooks/useCreateTestId.ts:18
Parameters
- config: TestIdGenerationProps = {}
Returns UseCreateTestIdResult

useDefaultResourceConfig

useDefaultResourceConfig<ResourceData, SourceData>(): ResourceDefaultConfig<ResourceData, SourceData>

- Defined in src/data-provider/resource-provider/hooks/useDefaultResourceConfig.ts:5
Type Parameters
- ResourceData
- SourceData = ResourceData
Returns ResourceDefaultConfig<ResourceData, SourceData>

useDistinctCallback

useDistinctCallback<Cb, T>(cb: undefined | Cb, equal?: ((prev: T, cur: T) => boolean), initial?: T): Cb

- Defined in src/django-spa/cdk/Hooks/useDistinctCallback.ts:3
Type Parameters
- Cb extends ((v: any) => void)
- T extends any
Parameters
- cb: undefined | Cb
- Optional equal: ((prev: T, cur: T) => boolean)
  - - (prev: T, cur: T): boolean
    - Parameters
      - prev: T
      - cur: T
      Returns boolean
- Optional initial: T
Returns Cb

useFactoryPropState

useFactoryPropState<T>(factory: (() => T), dependencies: readonly unknown[]): [T, ((val: T) => void)]

- Defined in src/django-spa/cdk/Hooks/Prop.state.ts:13
Type Parameters
- T
Parameters
- factory: (() => T)
  - - (): T
    - Returns T
- dependencies: readonly unknown[]
Returns [T, ((val: T) => void)]

useFetchResource

useFetchResource<ResourceData>(userConfigOrKey: ResourceOptionsOrKey<FetchResourceOptions<ResourceData, unknown>>): ((requestOptions?: FetchOptions<ResourceData, unknown>) => Promise<ResourceData>)

- Defined in src/data-provider/resource-provider/hooks/fetch-resource/useFetchResource.ts:9
Type Parameters
- ResourceData = unknown
Parameters
- userConfigOrKey: ResourceOptionsOrKey<FetchResourceOptions<ResourceData, unknown>>
Returns ((requestOptions?: FetchOptions<ResourceData, unknown>) => Promise<ResourceData>)
- - (requestOptions?: FetchOptions<ResourceData, unknown>): Promise<ResourceData>
  - Parameters
    - Optional requestOptions: FetchOptions<ResourceData, unknown>
    Returns Promise<ResourceData>

useField

useField(...tailArgs: [key: FieldKey, controlRef?: RefObject<ControlRefProps>]): UseFieldResult<unknown>

- Defined in src/django-spa/cdk/Forms/Fields/index.ts:12
Parameters
- Rest ...tailArgs: [key: FieldKey, controlRef?: RefObject<ControlRefProps>]
Returns UseFieldResult<unknown>

useFieldValidation

useFieldValidation(...tailArgs: [key: ErrorsKey, value: unknown, validator?: Validator]): UseFieldValidationResult

- Defined in src/django-spa/cdk/Forms/Validation/index.ts:10
Parameters
- Rest ...tailArgs: [key: ErrorsKey, value: unknown, validator?: Validator]
Returns UseFieldValidationResult

useForm

useForm(...tailArgs: Arr): UseFormResult

- Defined in src/django-spa/cdk/Forms/index.ts:7
Parameters
- Rest ...tailArgs: Arr
Returns UseFormResult

useGlobalConfig

useGlobalConfig<GlobalConfig>(): ConfigProviderValue<GlobalConfig>

- Defined in src/data-provider/config-provider/hooks/useGlobalConfig.ts:5
Type Parameters
- GlobalConfig extends BaseConfig
Returns ConfigProviderValue<GlobalConfig>

useIsMounted

useIsMounted(): RefObject<boolean>

- Defined in src/django-spa/cdk/Hooks/IsMounted.ref.ts:3
Returns RefObject<boolean>

useListData

useListData(): DataContext

- Defined in src/django-spa/components/integrators/ListView/Contexts/Data.tsx:20
Returns DataContext

useListFilters

useListFilters(...tailArgs: Arr): Updatable<FiltersValue>

- Defined in src/django-spa/components/integrators/ListView/Contexts/Params.tsx:58
Возвращает текущее значение фильтров и колбэк для их изменения

Parameters
- Rest ...tailArgs: Arr
Returns Updatable<FiltersValue>

useLogger

useLogger(): LoggingHandler

- Defined in src/django-spa/aspects/logger/Logger.context.ts:9
Returns LoggingHandler

useMutateResource

useMutateResource<ResourceData, SourceData, TError, TContext>(userConfigOrKey: ResourceOptionsOrKey<MutateResourceOptions<ResourceData, SourceData, TError, TContext>>, requestOptions?: MutationOptions<ResourceData, SourceData, TError, TContext>): MutationResult<ResourceData, SourceData, TError, TContext>

- Defined in src/data-provider/resource-provider/hooks/mutate-resource/useMutateResource.ts:9
Type Parameters
- ResourceData
- SourceData
- TError = unknown
- TContext = unknown
Parameters
- userConfigOrKey: ResourceOptionsOrKey<MutateResourceOptions<ResourceData, SourceData, TError, TContext>>
- requestOptions: MutationOptions<ResourceData, SourceData, TError, TContext> = {}
Returns MutationResult<ResourceData, SourceData, TError, TContext>

useNotifications

useNotifications(): NotificationsHandler

- Defined in src/django-spa/aspects/notifications/Notifications.context.ts:9
Returns NotificationsHandler

usePartialState

usePartialState<T>(initial: T): [T, ((val: Partial<T>) => void)]

- Defined in src/django-spa/cdk/Hooks/Partial.state.ts:3
Type Parameters
- T extends Record<string, unknown>
Parameters
- initial: T
Returns [T, ((val: Partial<T>) => void)]

usePreEffect

usePreEffect(callback: EffectCallback, deps?: DependencyList): boolean

- Defined in src/django-spa/cdk/Hooks/Pre.effect.ts:3
Parameters
- callback: EffectCallback
- Optional deps: DependencyList
Returns boolean

usePropState

usePropState<T>(initial: T): [T, ((val: T | ((prev: T) => T)) => void)]

- Defined in src/django-spa/cdk/Hooks/Prop.state.ts:3
Type Parameters
- T
Parameters
- initial: T
Returns [T, ((val: T | ((prev: T) => T)) => void)]

useRecord

useRecord(...tailArgs: Arr): RootProviderDesc

- Defined in src/django-spa/cdk/Forms/Fields/index.ts:16
Parameters
- Rest ...tailArgs: Arr
Returns RootProviderDesc

useRecordValidation

useRecordValidation(...tailArgs: Arr): UseRecordValidationResult

- Defined in src/django-spa/cdk/Forms/Validation/index.ts:16
Parameters
- Rest ...tailArgs: Arr
Returns UseRecordValidationResult

useResource

useResource<ResourceData>(userConfigOrKey: ResourceOptionsOrKey<QueryResourceOptions<ResourceData>>, requestOptions?: QueryOptions<ResourceData, unknown>): ResourceQueryResult<ResourceData, unknown>

- Defined in src/data-provider/resource-provider/hooks/fetch-resource/useResource.ts:9
Type Parameters
- ResourceData
Parameters
- userConfigOrKey: ResourceOptionsOrKey<QueryResourceOptions<ResourceData>>
- requestOptions: QueryOptions<ResourceData, unknown> = {}
Returns ResourceQueryResult<ResourceData, unknown>

useSaveEvent

useSaveEvent(): UseSaveEventApiResult

- Defined in src/DetailView/SaveEvent/SaveEventProvider.tsx:11
Returns UseSaveEventApiResult

useStoreApiState

useStoreApiState<T, Api>(store$: Store<T>, apiConfig: Api): [T, StoreApi<T, Api>]

- Defined in src/django-spa/cdk/Hooks/Store.state.ts:6
Type Parameters
- T
- Api extends ApiConfig<T>
Parameters
- store$: Store<T>
- apiConfig: Api
Returns [T, StoreApi<T, Api>]

useToastNotifications

useToastNotifications(): NotificationsHandler

- Defined in src/django-spa/aspects/notifications/Notifications.ts:7
Returns NotificationsHandler

useWidgetInitialization

useWidgetInitialization(initializationArguments: InitializationArguments, options?: UseWidgetInitializationOptions): InitializedWidgetAttributes

- Defined in src/common/hooks/useWidgetInitialization.tsx:29
Parameters
- initializationArguments: InitializationArguments
- Optional options: UseWidgetInitializationOptions
Returns InitializedWidgetAttributes

useZod

useZod(schema: ZodType): Validator

- Defined in src/django-spa/cdk/Validation/Zod.ts:6
Parameters
- schema: ZodType
Returns Validator

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

Accessor

Type Parameters

T

ArrayData

Type Parameters

T = unknown

ArrayValidator

Type declaration

Parameters

value: unknown

Returns Promise<ValidationResult[]>

BaseConfig

ConfigConsumerOptionsOrKey

Type Parameters

Config extends BaseConfig

DetailFieldDescription

Type declaration

Optional blockingValidators?: WidgetValueValidator[]

Optional dataSource?: GenericAccessor

Optional dataTarget?: GenericAccessor

Optional description?: GenericAccessor

Optional displayValue?: GenericAccessor

Optional helpText?: string

Optional href?: GenericAccessor

layout: LayoutData

name: string

Optional notBlockingValidators?: WidgetValueValidator[]

Optional required?: Accessor<boolean>

Optional showWidget?: Accessor<boolean>

Optional targetPayload?: GenericAccessor

widget: FunctionComponent<any> | Function

Optional widgetAnalytics?: GenericAccessor

FetchFn

Type Parameters

ResourceData = unknown

Type declaration

Parameters

resourceKey: string

Optional config: RequestConfig

Optional pageParams: any

Returns Promise<ResourceData>

FieldKey

FieldProps

Type Parameters

T

P

GenericAccessor

HttpClient

HttpResponse

Type Parameters

T = any

InputWidgetProps

LayoutComponent

Type Parameters

Children

Props = {}

Type declaration

Parameters

props: LayoutProps<Children, Props>

Returns JSX.Element

LayoutProps

Type Parameters

Children

Props = {}

ListFieldDescription

Type declaration

Optional Cell?: Function

Header: string

Optional accessor?: any

ListFilterDescription

Type declaration

Filter: FunctionComponent<any>