Socket
Socket
Sign inDemoInstall

rc-dialog

Package Overview
Dependencies
11
Maintainers
10
Versions
158
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

rc-dialog

dialog ui component for react


Version published
Maintainers
10
Weekly downloads
1,173,416
decreased by-7.4%

Weekly downloads

Package description

What is rc-dialog?

The rc-dialog package is a React component for creating and managing modals, dialogs, or popups in a React application. It provides a flexible and accessible way to generate dialog windows that can contain a wide range of content, from simple text to complex forms and interactive elements. The package offers various customization options, including animations, styles, and positioning, making it a versatile tool for UI development.

What are rc-dialog's main functionalities?

Basic Dialog Creation

This code sample demonstrates how to create a basic dialog with a title and some content. The dialog's visibility is controlled by a state variable.

import React from 'react';
import Dialog from 'rc-dialog';

const MyDialog = () => {
  const [visible, setVisible] = React.useState(false);
  return (
    <>
      <button onClick={() => setVisible(true)}>Open Dialog</button>
      <Dialog
        visible={visible}
        onClose={() => setVisible(false)}
        title='Dialog Title'
      >
        <p>This is a basic dialog example.</p>
      </Dialog>
    </>
  );
};

export default MyDialog;

Customizing Styles

This example shows how to apply custom styles to the dialog, including its width and the padding of its body content.

import React from 'react';
import Dialog from 'rc-dialog';

const MyStyledDialog = () => {
  const [visible, setVisible] = React.useState(false);
  return (
    <>
      <button onClick={() => setVisible(true)}>Open Styled Dialog</button>
      <Dialog
        visible={visible}
        onClose={() => setVisible(false)}
        title='Styled Dialog'
        style={{ width: 600 }}
        bodyStyle={{ padding: 20 }}
      >
        <p>This dialog has customized styles.</p>
      </Dialog>
    </>
  );
};

export default MyStyledDialog;

Modal with Footer

This code snippet illustrates how to add a footer to the dialog, which in this case contains a button to close the modal.

import React from 'react';
import Dialog from 'rc-dialog';

const ModalWithFooter = () => {
  const [visible, setVisible] = React.useState(false);
  return (
    <>
      <button onClick={() => setVisible(true)}>Open Modal with Footer</button>
      <Dialog
        visible={visible}
        onClose={() => setVisible(false)}
        title='Modal Title'
        footer={<button onClick={() => setVisible(false)}>Close</button>}
      >
        <p>This modal includes a footer with a close button.</p>
      </Dialog>
    </>
  );
};

export default ModalWithFooter;

Other packages similar to rc-dialog

Readme

Source

rc-dialog

react dialog component

NPM version dumi build status Test coverage Dependencies DevDependencies npm download bundle size

Screenshot

Example

http://localhost:8007/examples/

online example: https://dialog.react-component.vercel.app/

Install

rc-dialog

Usage

var Dialog = require('rc-dialog');

ReactDOM.render(
  <Dialog title={title} onClose={callback1} visible>
      <p>first dialog</p>
  </Dialog>
), document.getElementById('t1'));

// use dialog

API

rc-dialog

NameTypeDefaultDescriptionVersion
prefixClsStringrc-dialogThe dialog dom node's prefixCls
classNameStringadditional className for dialog
styleObject{}Root style for dialog element.Such as width, height
zIndexNumber
bodyStyleObject{}body style for dialog body element.Such as height
maskStyleObject{}style for mask element
visibleBooleanfalsecurrent dialog's visible status
animationStringpart of dialog animation css class name
maskAnimationStringpart of dialog's mask animation css class name
transitionNameStringdialog animation css class name
maskTransitionNameStringmask animation css class name
titleString|React.ElementTitle of the dialog
footerReact.Elementfooter of the dialog
closableBooleantruewhether show close button
maskBooleantruewhether show mask
maskClosableBooleantruewhether click mask to close
keyboardBooleantruewhether support press esc to close
mousePosition{x:number,y:number}set pageX and pageY of current mouse(it will cause transform origin to be set).
onClosefunction()called when click close button or mask
afterClosefunction()called when close animation end
getContainerfunction(): HTMLElementto determine where Dialog will be mounted
destroyOnCloseBooleanfalseto unmount child compenents on onClose
closeIconReactNodespecific the close icon.
forceRenderBooleanfalseCreate dialog dom node before dialog first show
focusTriggerAfterCloseBooleantruefocus trigger element when dialog closed
modalRender(node: ReactNode) => ReactNodeCustom modal content render8.3.0

Development

npm install
npm start

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

open coverage/ dir

License

rc-dialog is released under the MIT license.

Keywords

FAQs

Last updated on 09 Jun 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc