@lynx-js/lynx-ui-dialog
v3.130.0
Published
A headless Dialog (modal) component for ReactLynx. It provides backdrop overlay, open/close state management, and enter/exit animations via Presence.
Readme
@lynx-js/lynx-ui-dialog
A headless Dialog (modal) component for ReactLynx. It provides backdrop overlay, open/close state management, and enter/exit animations via Presence.
Installation
We strongly recommend installing and using this component through the main @lynx-js/lynx-ui package:
# pnpm (recommended)
pnpm add @lynx-js/lynx-ui
# npm
npm install @lynx-js/lynx-ui
# yarn
yarn add @lynx-js/lynx-ui(If necessary, you can still install the standalone package via pnpm add @lynx-js/lynx-ui-dialog)
Usage
The lynx-ui-dialog follows a headless composition pattern.
Component Structure
The Dialog component is composed of several specialized sub-components to give you full control over the layout and styling.
<DialogRoot>
<DialogTrigger />
<DialogView>
<DialogBackdrop />
<DialogContent>
<DialogClose />
</DialogContent>
</DialogView>
</DialogRoot>DialogRoot: The root container that manages the state.DialogView: The viewport container for the dialog components.DialogBackdrop: The dimmed overlay behind the dialog.DialogContent: The actual dialog panel that contains your content.DialogTrigger: A button that opens the dialog.DialogClose: A button that closes the dialog.
About @lynx-js/lynx-ui
This component is part of @lynx-js/lynx-ui, a headless UI library officially maintained by the Lynx team, provided as a reference for building flexible, universal, and high-performance ReactLynx components.
License
lynx-ui is Apache License 2.0 licensed.
