ComponentBuilder | usestable

Type Parameters

C
O
P = O

Hierarchy

ComponentBuilder

Index

Methods

end

end(): (C extends void ? FC : C) & { props: P }

- Defined in packages/usestable/lib/main.ts:536
end building process and return a component

Returns (C extends void ? FC : C) & { props: P }

map

map<TName, TValue>(name: TName, mapper: ((value: TValue, props: P) => O[TName])): ComponentBuilder<void, O, P & (TValue extends void ? { [ key in string | number | symbol]?: TValue } : { [ key in string | number | symbol]: TValue })>

- Defined in packages/usestable/lib/main.ts:491
Type Parameters
- TName extends string | number | symbol
- TValue = O[TName]
Parameters
- name: TName
- mapper: ((value: TValue, props: P) => O[TName])
 - - (value: TValue, props: P): O[TName]
 - Parameters
 - value: TValue
 - props: P
 Returns O[TName]
Returns ComponentBuilder<void, O, P & (TValue extends void ? { [ key in string | number | symbol]?: TValue } : { [ key in string | number | symbol]: TValue })>

memo

memo(areEqual?: ((prev: P, next: P) => boolean)): ComponentBuilder<C, O, P>

- Defined in packages/usestable/lib/main.ts:455
apply memoizing for compound component

Parameters
- Optional areEqual: ((prev: P, next: P) => boolean)
 - - (prev: P, next: P): boolean
 - Parameters
 - prev: P
 - next: P
 Returns boolean
Returns ComponentBuilder<C, O, P>

prop

prop<TValue>(name: keyof O, values: TValue[]): ComponentBuilder<void, O, P & { [ key in string]?: boolean }>
prop<TName, TValue>(name: TName, compute: ((value: TValue, props: P) => Partial<O>)): ComponentBuilder<void, O, P & (TValue extends void ? { [ key in string]?: TValue } : { [ key in string]: TValue })>
prop<TName, TMap>(name: TName, map: TMap): ComponentBuilder<void, O, P & { [ key in string | number | symbol]?: boolean }>

- Defined in packages/usestable/lib/main.ts:446
create component prop with specified valid values

Type Parameters
- TValue extends string
Parameters
- name: keyof O
- values: TValue[]
Returns ComponentBuilder<void, O, P & { [ key in string]?: boolean }>
- Defined in packages/usestable/lib/main.ts:468
create computed prop

Type Parameters
- TName extends string = string
- TValue = unknown
Parameters
- name: TName
- compute: ((value: TValue, props: P) => Partial<O>)
 - - (value: TValue, props: P): Partial<O>
 - Parameters
 - value: TValue
 - props: P
 Returns Partial<O>
Returns ComponentBuilder<void, O, P & (TValue extends void ? { [ key in string]?: TValue } : { [ key in string]: TValue })>
- Defined in packages/usestable/lib/main.ts:486
create new prop that has specified values

Type Parameters
- TName extends string | number | symbol
- TMap extends Record<string, string>
Parameters
- name: TName
- map: TMap
Returns ComponentBuilder<void, O, P & { [ key in string | number | symbol]?: boolean }>

rename

rename<TOld, TNew>(oldName: TOld, newName: TNew): ComponentBuilder<void, O, Omit<P, TOld> & { [ key in string]: P[TOld] }>

- Defined in packages/usestable/lib/main.ts:503
Type Parameters
- TOld extends string | number | symbol
- TNew extends string
Parameters
- oldName: TOld
- newName: TNew
Returns ComponentBuilder<void, O, Omit<P, TOld> & { [ key in string]: P[TOld] }>

render

render<TNewProps, TRef>(renderFn: ((component: FC, props: TNewProps, ref: ForwardedRef<TRef>) => any)): ComponentBuilder<void, O, TNewProps>

- Defined in packages/usestable/lib/main.ts:512
use renderFn to render compound component, the renderFn retrives compound component, input props, ref

Type Parameters
- TNewProps = P
- TRef = any
Parameters
- renderFn: ((component: FC, props: TNewProps, ref: ForwardedRef<TRef>) => any)
 - - (component: FC, props: TNewProps, ref: ForwardedRef<TRef>): any
 - Parameters
 - component: FC
 - props: TNewProps
 - ref: ForwardedRef<TRef>
 Returns any
Returns ComponentBuilder<void, O, TNewProps>

stable

stable(options?: Options): ComponentBuilder<C, O, P>

- Defined in packages/usestable/lib/main.ts:461
apply stabling for compound component

Parameters
- Optional options: Options
Returns ComponentBuilder<C, O, P>

use

use<TNewProps, TArgs>(hoc: ((component: FC, ...args: TArgs) => Component<TNewProps, {}, any> | FC<TNewProps>), ...args: TArgs): ComponentBuilder<void, O, TNewProps>

- Defined in packages/usestable/lib/main.ts:525
use HOC

Type Parameters
- TNewProps = P
- TArgs extends any[] = []
Parameters
- hoc: ((component: FC, ...args: TArgs) => Component<TNewProps, {}, any> | FC<TNewProps>)
 - - (component: FC, ...args: TArgs): Component<TNewProps, {}, any> | FC<TNewProps>
 - Parameters
 - component: FC
 - Rest ...args: TArgs
 Returns Component<TNewProps, {}, any> | FC<TNewProps>
- Rest ...args: TArgs
Returns ComponentBuilder<void, O, TNewProps>

Type Parameters

C

O

P = O

Hierarchy

Index

Methods

Methods

end

Returns (C extends void ? FC<P> : C) & { props: P }

map

Type Parameters

TName extends string | number | symbol

TValue = O[TName]

Parameters

name: TName

mapper: ((value: TValue, props: P) => O[TName])

Parameters

value: TValue

props: P

Returns O[TName]

Returns ComponentBuilder<void, O, P & (TValue extends void ? { [ key in string | number | symbol]?: TValue } : { [ key in string | number | symbol]: TValue })>

memo

Parameters

Optional areEqual: ((prev: P, next: P) => boolean)

Parameters

prev: P

next: P

Returns boolean

Returns ComponentBuilder<C, O, P>

prop

Type Parameters

TValue extends string

Parameters

name: keyof O

values: TValue[]

Returns ComponentBuilder<void, O, P & { [ key in string]?: boolean }>

Type Parameters

TName extends string = string

TValue = unknown

Parameters

name: TName

compute: ((value: TValue, props: P) => Partial<O>)

Parameters

value: TValue

props: P

Returns Partial<O>

Returns ComponentBuilder<void, O, P & (TValue extends void ? { [ key in string]?: TValue } : { [ key in string]: TValue })>

Type Parameters

TName extends string | number | symbol

TMap extends Record<string, string>

Parameters

name: TName

map: TMap

Returns ComponentBuilder<void, O, P & { [ key in string | number | symbol]?: boolean }>

rename

Type Parameters

TOld extends string | number | symbol

TNew extends string

Parameters

oldName: TOld

newName: TNew

Returns ComponentBuilder<void, O, Omit<P, TOld> & { [ key in string]: P[TOld] }>

render

Type Parameters

TNewProps = P

TRef = any

Parameters

renderFn: ((component: FC<P>, props: TNewProps, ref: ForwardedRef<TRef>) => any)

Parameters

component: FC<P>

props: TNewProps

ref: ForwardedRef<TRef>

Returns any

Returns ComponentBuilder<void, O, TNewProps>

stable

Parameters

Optional options: Options<P>

Returns ComponentBuilder<C, O, P>

use