Based on Overlastic v0.8.7. A promise-based modal/dialog/popup library supporting React, Vue, and Svelte.
Core References
| Topic | Description | Reference |
|---|---|---|
| Constructor | Core method for creating overlay constructors | core-constructor |
| Deferred | Promise variation with external control methods | core-deferred |
| Global Functions | Utilities for mounting elements and name management | core-defines |
| useDisclosure | Hook for managing overlay lifecycle and state | core-disclosure |
Framework References
| Topic | Description | Reference |
|---|---|---|
| React Integration | Using Overlastic with React components | framework-react |
| Vue Integration | Using Overlastic with Vue 3 components | framework-vue |
| Svelte Integration | Using Overlastic with Svelte components | framework-svelte |
Advanced References
| Topic | Description | Reference |
|---|---|---|
| Provider Pattern | Using OverlaysProvider for context inheritance | advanced-provider |
| Custom Components | Integrating existing component libraries | advanced-customization |
| External Control | Controlling overlay lifecycle from outside | advanced-external-control |
| Declarative Usage | Using overlays in templates/JSX | advanced-declarative |
Key Concepts
- Constructor: Receives component, props, and options to mount overlays
- Deferred: Promise-like object with
confirmandcancelmethods for external control - Mount Options: Configuration for container, ID, index, and deferred instance
- Lifecycle: Components are destroyed after
durationends when deferred resolves/rejects - Imperative Usage:
defineOverlayandrenderOverlayfor callback-based invocation - Declarative Usage: Components can be used in templates/JSX with props
- Provider Pattern:
OverlaysProviderfor context inheritance - Dual Mode Support: Components work in both imperative and declarative modes