generated from gravity-ui/package-example
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Confirm): add confirm component
- Loading branch information
kseniyakuzina
committed
Mar 22, 2024
1 parent
7a93a52
commit 01079f5
Showing
7 changed files
with
174 additions
and
1 deletion.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
@use '@gravity-ui/uikit/styles/mixins'; | ||
@use '../../components/variables'; | ||
|
||
$block: '.#{variables.$ns}confirm-dialog'; | ||
|
||
#{$block} { | ||
&__message { | ||
@include mixins.text-body-2; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
import React from 'react'; | ||
|
||
import type {DialogProps} from '@gravity-ui/uikit'; | ||
import {Dialog, DialogFooterProps} from '@gravity-ui/uikit'; | ||
|
||
import {block} from '../utils/cn'; | ||
|
||
import './ConfirmDialog.scss'; | ||
|
||
const b = block('confirm-dialog'); | ||
|
||
export type ConfirmDialogProps = { | ||
title?: string; | ||
message?: React.ReactNode; | ||
} & Omit<DialogProps, 'children'> & | ||
Pick< | ||
DialogFooterProps, | ||
| 'textButtonApply' | ||
| 'textButtonCancel' | ||
| 'onClickButtonCancel' | ||
| 'onClickButtonApply' | ||
| 'propsButtonCancel' | ||
| 'propsButtonApply' | ||
>; | ||
|
||
export const ConfirmDialog = ({ | ||
title, | ||
message, | ||
textButtonApply, | ||
textButtonCancel, | ||
onClickButtonApply, | ||
onClickButtonCancel, | ||
propsButtonCancel, | ||
propsButtonApply, | ||
...dialogProps | ||
}: ConfirmDialogProps) => { | ||
return ( | ||
<Dialog {...dialogProps}> | ||
<Dialog.Header caption={title} /> | ||
<Dialog.Body> | ||
<div className={b('message')}>{message}</div> | ||
</Dialog.Body> | ||
<Dialog.Footer | ||
preset="default" | ||
showError={false} | ||
listenKeyEnter | ||
textButtonApply={textButtonApply} | ||
textButtonCancel={textButtonCancel} | ||
onClickButtonApply={onClickButtonApply} | ||
onClickButtonCancel={onClickButtonCancel} | ||
propsButtonCancel={propsButtonCancel} | ||
propsButtonApply={propsButtonApply} | ||
/> | ||
</Dialog> | ||
); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
<!--GITHUB_BLOCK--> | ||
|
||
# ConfirmDialog | ||
|
||
<!--/GITHUB_BLOCK--> | ||
|
||
```tsx | ||
import {ConfirmDialog} from '@gravity-ui/components'; | ||
``` | ||
|
||
`ConfirmDialog` is a utility component, which renders confirmation dialogs | ||
|
||
## Properties | ||
|
||
| Name | Description | Type | Required | | ||
| :------------------ | :------------------------------ | :--------------------------------------------------------------------------------------------: | :------: | | ||
| title | The confirm dialog title | `string` | Yes | | ||
| message | The confirmation message | `ReactNode` | Yes | | ||
| textButtonCancel | The cancel button text | `string` | Yes | | ||
| propsButtonCancel | The cancel buttonProps | `ButtonProps` | | | ||
| onClickButtonCancel | The cancel button click handler | `(event: React.MouseEvent<HTMLElement, MouseEvent>) => void` | Yes | | ||
| textButtonApply | The ok button text | `string` | Yes | | ||
| propsButtonApply | The ok button props | `ButtonProps` | | | ||
| onClickButtonApply | The ok button click handler | `(event: React.MouseEvent<HTMLElement, MouseEvent>) => void` | Yes | | ||
| onClose | The dialog close handler | `(event: MouseEvent or KeyboardEvent, reason: ModalCloseReason or 'closeButtonClick') => void` | Yes | | ||
|
||
And other Dialog props | ||
|
||
## Usage | ||
|
||
```tsx | ||
import {ConfirmDialog} from '@gravity-ui/components'; | ||
|
||
const [open, setOpen] = React.useState(false); | ||
|
||
return ( | ||
<React.Fragment> | ||
<Button view="normal" onClick={() => setOpen(true)}> | ||
Show confirm | ||
</Button> | ||
<ConfirmDialog | ||
{...args} | ||
title="Do you want to confirm?" | ||
onClickButtonApply={() => { | ||
alert('Confirmed'); | ||
setOpen(false); | ||
}} | ||
onClickButtonCancel={() => { | ||
alert('Cancelled'); | ||
setOpen(false); | ||
}} | ||
onClose={() => setOpen(false)} | ||
textButtonCancel="No" | ||
textButtonApply="Yes" | ||
open={open} | ||
aria-labelledby="app-confirmation-dialog-title" | ||
/> | ||
</React.Fragment> | ||
); | ||
``` |
45 changes: 45 additions & 0 deletions
45
src/components/ConfirmDialog/__stories__/ConfirmDialog.stories.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
import React from 'react'; | ||
|
||
import {Button} from '@gravity-ui/uikit'; | ||
import type {Meta, StoryFn} from '@storybook/react'; | ||
|
||
import {ConfirmDialog} from '../ConfirmDialog'; | ||
import type {ConfirmDialogProps} from '../ConfirmDialog'; | ||
|
||
export default { | ||
title: 'Components/ConfirmDialog', | ||
component: ConfirmDialog, | ||
} as Meta<ConfirmDialogProps>; | ||
|
||
const DefaultTemplate: StoryFn<ConfirmDialogProps> = (args) => { | ||
const [open, setOpen] = React.useState(false); | ||
|
||
return ( | ||
<React.Fragment> | ||
<Button view="normal" onClick={() => setOpen(true)}> | ||
Show confirm | ||
</Button> | ||
<ConfirmDialog | ||
{...args} | ||
onClickButtonApply={() => { | ||
alert('Confirmed'); | ||
setOpen(false); | ||
}} | ||
onClickButtonCancel={() => { | ||
alert('Cancelled'); | ||
setOpen(false); | ||
}} | ||
onClose={() => setOpen(false)} | ||
open={open} | ||
/> | ||
</React.Fragment> | ||
); | ||
}; | ||
export const Default = DefaultTemplate.bind({}); | ||
|
||
Default.args = { | ||
title: 'Do you want to confirm?', | ||
textButtonCancel: 'No', | ||
textButtonApply: 'Yes', | ||
'aria-labelledby': 'app-confirmation-dialog-title', | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export * from './ConfirmDialog'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters