overlastic

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Based on Overlastic v0.8.7. A promise-based modal/dialog/popup library supporting React, Vue, and Svelte.
基于Overlastic v0.8.7版本,这是一个基于Promise的模态框/对话框/弹出层库,支持React、Vue和Svelte。

Core References

核心参考文档

TopicDescriptionReference
ConstructorCore method for creating overlay constructorscore-constructor
DeferredPromise variation with external control methodscore-deferred
Global FunctionsUtilities for mounting elements and name managementcore-defines
useDisclosureHook for managing overlay lifecycle and statecore-disclosure
主题描述参考链接
构造函数创建弹出层构造器的核心方法core-constructor
Deferred带有外部控制方法的Promise变体core-deferred
全局函数用于挂载元素和名称管理的工具函数core-defines
useDisclosure用于管理弹出层生命周期和状态的Hookcore-disclosure

Framework References

框架集成参考文档

TopicDescriptionReference
React IntegrationUsing Overlastic with React componentsframework-react
Vue IntegrationUsing Overlastic with Vue 3 componentsframework-vue
Svelte IntegrationUsing Overlastic with Svelte componentsframework-svelte
主题描述参考链接
React集成在React组件中使用Overlasticframework-react
Vue集成在Vue 3组件中使用Overlasticframework-vue
Svelte集成在Svelte组件中使用Overlasticframework-svelte

Advanced References

高级参考文档

TopicDescriptionReference
Provider PatternUsing OverlaysProvider for context inheritanceadvanced-provider
Custom ComponentsIntegrating existing component librariesadvanced-customization
External ControlControlling overlay lifecycle from outsideadvanced-external-control
Declarative UsageUsing overlays in templates/JSXadvanced-declarative
主题描述参考链接
提供者模式使用OverlaysProvider实现上下文继承advanced-provider
自定义组件集成现有组件库advanced-customization
外部控制从外部控制弹出层生命周期advanced-external-control
声明式用法在模板/JSX中使用弹出层advanced-declarative

Key Concepts

核心概念

  • Constructor: Receives component, props, and options to mount overlays
  • Deferred: Promise-like object with
    confirm
    and
    cancel
    methods for external control
  • Mount Options: Configuration for container, ID, index, and deferred instance
  • Lifecycle: Components are destroyed after
    duration
    ends when deferred resolves/rejects
  • Imperative Usage:
    defineOverlay
    and
    renderOverlay
    for callback-based invocation
  • Declarative Usage: Components can be used in templates/JSX with props
  • Provider Pattern:
    OverlaysProvider
    for context inheritance
  • Dual Mode Support: Components work in both imperative and declarative modes
  • 构造函数:接收组件、属性和选项来挂载弹出层
  • Deferred:类似Promise的对象,带有
    confirm
    cancel
    方法用于外部控制
  • 挂载选项:用于配置容器、ID、索引和Deferred实例
  • 生命周期:当Deferred状态变更(resolve/reject)后,组件会在
    duration
    结束后销毁
  • 命令式用法:使用
    defineOverlay
    renderOverlay
    进行基于回调的调用
  • 声明式用法:组件可在模板/JSX中通过属性使用
  • 提供者模式:使用
    OverlaysProvider
    实现上下文继承
  • 双模式支持:组件同时支持命令式和声明式两种使用方式