@arnat/styled-modal
v0.0.12
Published
The bootstrap modal component created with styled-components
Downloads
22
Readme
ARNAT - styled-modal
Modular approach to use bootstrap components for quick prototypes, as an entrypoint of the component library.
Usage
import React, { useState } from 'react';
import { Modal, ModalBody, ModalFooter, ModalHeader, ModalTitle } from '@arnat/styled-modal';
export const ModalExample = () => {
const [hidden, setHidden] = useState(true);
return (
<div>
<Modal hidden={hidden} toggle={() => setHidden(!hidden)}>
<ModalHeader>
<ModalTitle>Modal Title</ModalTitle>
<button outline onClick={() => setHidden(!hidden)}>
<span aria-hidden="true">×</span>
</button>
</ModalHeader>
<ModalBody>Modal body text goes here.</ModalBody>
<ModalFooter>
<button onClick={() => setHidden(!hidden)}>Close</button>
</ModalFooter>
</Modal>
<button block danger onClick={() => setHidden(!hidden)}>
Launch Modal
</button>
</div>
);
};
Properties
Properties which can be added to the component to change the visual appearance.
sm
only on Modal Type: booleanlg
only on Modal Type: booleanhidden
only on Modal Type: booleantoggle
only on Modal Type: functioncentered
only on Modal Type: booleanbackdrop
only on Modal Type: boolean or stringnoRadius
only on Modal Type: booleanreturnFocusAfterClose
only on Modal Type: booleantransitionProps
only on Modal Type: objectwrapperProps
only on Modal Type: objectdialogProps
only on Modal Type: objectcontentProps
only on Modal Type: objectbackdropProps
only on Modal Type: objectTransitionComponent
only on Modal Type: Component (with forwarded ref)ModalWrapperComponent
only on Modal Type: Component (with forwarded ref)ModalDialogComponent
only on Modal Type: ComponentModalBackdropComponent
only on Modal Type: ComponentModalContentComponent
only on Modal Type: Component
Property
backdrop
can be set to false or 'static' to prevent dialog from closing on click outsite of the window.