@wildberries/confirm-modal-portal
TypeScript icon, indicating that this package has built-in type declarations

0.1.6 • Public • Published

@wildberries/confirm-modal-portal

Build Status

Sollution for confirm modals, connected with redux, based on

@wildberries/ui-kit

Examples of usage

Installation

npm install @wildberries/confirm-modal-portal

Connect to your root reducer

import {
  CONFIRM_MODALS_REDUCER_NAME,
  confirmModalModuleReducer,
} from '@wildberries/confirm-modal-portal';

export const rootReducer = {
  [CONFIRM_MODALS_REDUCER_NAME]: confirmModalModuleReducer,
};

Insert the ConfirmModal component into your project

import React, { memo } from "react";
import { ConfirmModal } from '@wildberries/confirm-modal-portal';

const TestComponent = memo(() => (
    <ConfirmModal />
  )
)

Dispatch setConfirmModalAction to add confirm modal

SetModalAction params:

  • title - title of the modal
  • content - modal content (React component)
  • titleSize - title size
  • size - modal size
  • confirmActionParams - params of modal confirmation process (see below)
  • confirmButtonProps - params of confirm button
  • cancelButtonProps- params of cancel button
  • noPadding - set padding 0

ConfirmActionParams params:

  • requestParamsFormatter - formatter before equest data will be sent
  • request - the request that needs to be confirmed
  • requestParams - params that will be set to the request
  • setErrorAction - the action that will be dispatched when error from the request comes
  • setErrorActionsArray - the array of actions that will be dispatched when error from the request comes
  • setSuccessAction - the action that will be dispatched when success from the request comes
  • setSuccessActionsArray - the array of actions that will be dispatched when success from the request comes
  • notificationSuccessConfig - the text config for the successful notification
  • notificationErrorConfig - the text config for the error notification
  • responseDataFormatter - formatter of the data that goes to the success action (or an array of actions)
  • resetInitialFormValuesAction - resetting form values (RFF needs if connected to the redux)
  • showNotificationError - flag to show error notification when error from the request comes
  • showNotificationSuccess - flag to show success notification when success from the request comes

Please, Be careful, these actions are not from connect - but pure actions:

  • setErrorAction
  • setErrorActionsArray
  • setSuccessAction
  • setSuccessActionsArray
import React from "react";
import {
  setConfirmModalAction,
  ConfirmModalStateType,
  closeConfirmModalAction,
} from '@wildberries/confirm-modal-portal';
import { useDispatch } from "react-redux";

function ExampleComponent() {
  const dispatch = useDispatch();

  const openConfirmModal = () => {
    dispatch(
      this.props.setConfirmModalAction({
        content: <SomeYourContentComponent />,
        confirmActionParams: {
          request: deleteUserFromSupplierRequest,
          requestParams: { foo: 'bar' },
          setSuccessActionsArray: [
            this.props.closeConfirmModal,
            () =>
              this.props.deleteSupplierUser({
                supplierId,
                userId,
              }),
          ],
          notificationSuccessConfig: {title:'Пользователь был удалён'},
          showNotificationError: true,
          showNotificationSuccess: true,
        },
        confirmButtonProps: {
          text: 'Удалить',
        },
        cancelButtonProps: {
          text: 'Отмена',
        },
      })
  }

  return (
    <div className="ExampleComponent">
        <button onClick={openConfirmModal}>button</button>
    </div>
  );
}

export default ExampleComponent;

Please, be careful

  • close modal action always adds to the user redux actions if you need not to close confirm modal after successful request please set notCloseAfterSuccessRequest option to true

Readme

Keywords

none

Package Sidebar

Install

npm i @wildberries/confirm-modal-portal

Weekly Downloads

2,081

Version

0.1.6

License

MIT

Unpacked Size

40 kB

Total Files

29

Last publish

Collaborators

  • novikov
  • vladislav137
  • mihanizm56
  • ramison4ik