Struct consecuit::construction::component::ComponentBuilder

pub struct ComponentBuilder { /* fields omitted */ }

The initial consecuit or cc object every component takes as first argument.

For more information on how to write components, see the docs at crate.

Implementations

impl ComponentBuilder

pub fn init<T: StoresList>(
    self
) -> ComponentConstruction<T, T, NoHoleNode, NoHoleNode>

Make it ready to call .hook(...), .comp(...). You shouldn’t need this, as we have a shortbut that automatically call it when you call .hook(...), .comp(...).

impl ComponentBuilder

pub fn hook<Arg, Out, Ret, RestStores>(
    self,
    hook_func: fn(_: HookBuilder, _: Arg) -> Ret,
    hook_arg: Arg
) -> (ComponentConstruction<RestStores, StoreCons<Ret::StoresList, RestStores>, NoHoleNode, NoHoleNode>, Out) where
    RestStores: StoresList,
    Ret: HookReturn<Out>, 

This is a shortcut that calls cc.init().hook(...)

It is here so you don’t have to write let cc = cc.init(); at the beginning of every component.

See the docs at crate on how to call hooks. See ComponentConstruction for the actual .hook(...).

pub fn comp<Props, Ret, RestStores>(
    self,
    component_func: ComponentFunc<Ret, Props>,
    component_props: Props
) -> ComponentConstruction<RestStores, StoreCons<ComponentStoreInstance<Ret, Props>, RestStores>, Ret::HoleNode, NoHoleNode> where
    RestStores: StoresList,
    Ret: ComponentReturn,
    Props: ComponentProps, 

This is a shortcut that calls cc.init().comp(...)

It is here so you don’t have to write let cc = cc.init(); at the beginning of every component.

See the docs at crate on how to compose components. See ComponentConstruction for the actual .comp(...).

pub fn dyn_comp<Props, Ret, RestStores>(
    self,
    component_func: ComponentFunc<Ret, Props>,
    component_props: Props
) -> ComponentConstruction<RestStores, StoreCons<RefCell<Option<Box<dyn Subtree<Props = Props>>>>, RestStores>, NoHoleNode, NoHoleNode> where
    RestStores: StoresList,
    Ret: ComponentReturn,
    Props: ComponentProps, 

This is a shortcut that calls cc.init().dyn_comp(...)

It is here so you don’t have to write let cc = cc.init(); at the beginning of every component.

See ComponentConstruction for the actual .dyn_comp(...) for more details.