Expand description
Component model for Orbit UI framework
This module contains all the types and traits related to the component model, including lifecycle management, state, props, and rendering.
Modules§
- props
- Props module for component properties
Structs§
- Callback
- A callback function that can be passed as a prop
- Component
Base - Base component functionality that all components share
- Component
Id - Unique identifier for component instances
- Component
Instance - Wraps a component instance with its metadata
- Component
Tree - Manager for the component tree
- Composition
Builder - Composition utilities and builder patterns
- Context
- Context passed to components providing access to state, events, and shared context
- Context
Provider - Provider for component context
- Enhanced
Context - Context passed to components providing access to state and events
- Flexible
Compound Component - A flexible compound component implementation
- Flexible
Compound Props - HOCWrapper
- A generic higher-order component wrapper
- Lazy
Component - Lazy loading component wrapper
- Lifecycle
Hooks - Lifecycle hook options for components
- Lifecycle
Manager - Manages the lifecycle of components
- Memo
Cache - Memoization cache for component render results
- Memo
Component - Memoized component wrapper
- Module
Update Scheduler - Scheduler for batching component updates
- Mount
Context - Context provided during component mounting
- Mount
Options - Options for component mounting
- Node
- A node in the UI tree with event delegation support
- Performance
Monitor - Performance monitoring hooks
- Performance
Registry - Global performance optimization registry
- Render
Prop Component - A component that uses render props pattern
- Render
Prop Props - Props for render prop component
- Render
Statistics - Render
Timer - Timer for measuring render performance
- Slot
- Slot-based composition system
- Slotted
Component - A basic slotted component implementation
- Slotted
Props - Props for slotted components
- State
Change - Represents a specific change to component state
- State
Changes - Collection of state changes for batching
- State
Snapshot - Represents a snapshot of component state at a point in time
- State
Tracker - Tracks state changes for a component with dirty checking optimization
- State
Tracking Config - Configuration options for state tracking
- Unmount
Context - Context provided during component unmounting
- Update
Batcher - Batched update system for performance optimization
- Update
Scheduler - Manages batched updates for improved performance
- With
Logging - Common HOC patterns
- With
Performance Monitoring - HOC that adds performance monitoring
Enums§
- Change
Priority - Priority levels for state changes
- Component
Error - Errors that can occur during component operations
- Lifecycle
Phase - Lifecycle phase of a component
- Load
Trigger - State
Value - Represents different types of state values that can be tracked
- Tree
Error - Errors specific to tree operations
- Unmount
Reason - Reasons for component unmounting
- Update
Priority - Priority level for component updates
Traits§
- AnyComponent
- Type-erased component trait for dynamic dispatch
- Component
- Enhanced component trait with improved lifecycle management
- Compound
Component - Compound component pattern - a component made of multiple sub-components
- Higher
Order Component - Trait for defining higher-order component behavior
- Memoizable
- Trait for memoizable components
- Props
- Props trait - implemented by all component props types
- Render
Prop - Trait for components that can render other components (render props pattern)
- Sized
Props - Marker trait to ensure props are sized
- Slotted
- Trait for components that support slots
Functions§
- callback
- Convenience function for creating a callback
Type Aliases§
- Lifecycle
Callback - Type for lifecycle callback functions
- Logged
Component - Convenient type aliases for common HOCs
- Monitored
Component - Tree
Result - Result type for tree operations