wirestate-lit
Commands
| Name | Description |
|---|---|
| OnCommandController | Reactive controller that registers a command handler. |
| OnCommandDecorator | Represents type returned by onCommand. |
| UseOnCommandOptions | Represents options for useOnCommand. |
| onCommand | Decorator for Lit element methods that handle a specific command. |
| useOnCommand | Registers a command handler for the host element's lifetime. |
Consumption
| Name | Description |
|---|---|
| InjectionDecorator | Represents type returned by injection. |
| InjectionOptions | Represents options for injection. |
| OptionalInjectionDecorator | Represents type returned by optionalInjection. |
| OptionalInjectionOptions | Represents options for optionalInjection. |
| UseContainerValue | Represents value returned by useContainer. |
| UseInjectionOptions | Represents options for useInjection. |
| UseInjectionValue | Represents value returned by useInjection. |
| UseOptionalInjectionOptions | Represents options for useOptionalInjection. |
| UseOptionalInjectionValue | Represents value returned by useOptionalInjection. |
| OptionalInjectionFallback | Provides a fallback value when an optional injection is not bound. |
| UseScopeValue | Represents value returned by useScope. |
| injection | Injects a container value into a Lit element property. |
| optionalInjection | Injects a container value if it exists. |
| useContainer | Consumes the active container from the nearest Lit context. |
| useInjection | Consumes a service from the nearest Lit container context. |
| useOptionalInjection | Consumes a service if the nearest container has it. |
| useScope | Consumes a WireScope from the nearest Lit container context. |
Context
| Variable | Description |
|---|---|
| ContainerContext | Lit context object for providing and consuming the container. |
Events
| Name | Description |
|---|---|
| OnEventController | Reactive controller that subscribes to container events. |
| OnEventDecorator | Represents type returned by onEvent. |
| UseOnEventsOptions | Represents options for useOnEvents. |
| onEvent | Decorator for Lit element methods that handle events from the event bus. |
| useOnEvents | Subscribes to events for the host element's lifetime. |
Provision
| Name | Description |
|---|---|
| ContainerProvider | Reactive controller that provides a root container through Lit context. |
| SubContainerProvider | Reactive controller that provides a managed child container. |
| ContainerProviderDecorator | Represents the type returned by containerProvide. |
| ContainerProviderOptions | Represents options for ContainerProvider. |
| SubContainerProviderDecorator | Represents type returned by subContainerProvide. |
| SubContainerProviderOptions | Represents options for SubContainerProvider. |
| UseContainerProvisionOptions | Represents options for useContainerProvision. |
| containerProvide | Decorator that provides an IoC container to child components. |
| subContainerProvide | Decorator that provides a managed child container derived from the nearest parent container context. |
| useContainerProvision | Hook that provides a container to the host element and its children. |
| useSubContainerProvider | Hook that provides a managed child container for the host element's lifetime. |
Queries
| Name | Description |
|---|---|
| OnQueryController | Reactive controller that registers a query handler. |
| OnQueryDecorator | Represents type returned by onQuery. |
| UseOnQueryOptions | Represents options for useOnQuery. |
| onQuery | Decorator for Lit element methods that handle a specific query. |
| useOnQuery | Registers a query handler for the host element's lifetime. |