generated from gravity-ui/package-example
-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: made a new password input component #108
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
810becd
feat(Password): made a new input password
NasgulNexus e7ea3aa
fix: deleted unnecessary files
NasgulNexus f69fd7f
fix: delete lodash
NasgulNexus 77b7def
fix: add stories WithGenerateRandomValueTemplate
NasgulNexus 9f89baa
fix: added browser default to ignore
NasgulNexus 110608c
fix: correct remarks
NasgulNexus 868a5ac
fix: corrected comments
NasgulNexus 7603a3d
fix: name helpers function
NasgulNexus 5c5959d
fix: fix spread control props
NasgulNexus a8098e4
Merge branch 'main' into password
NasgulNexus File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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,21 @@ | ||
@use '../variables'; | ||
|
||
$block: '.#{variables.$ns}password-input'; | ||
|
||
#{$block} { | ||
&__input-control { | ||
&::-ms-reveal, | ||
&::-ms-clear { | ||
display: none; | ||
} | ||
} | ||
|
||
&__additional-right-content { | ||
display: flex; | ||
align-items: center; | ||
} | ||
|
||
&__copy-button { | ||
margin-right: 4px; | ||
} | ||
} |
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,110 @@ | ||
import React from 'react'; | ||
|
||
import {Eye, EyeSlash} from '@gravity-ui/icons'; | ||
import {Button, ClipboardButton, Icon, TextInput, TextInputProps, Tooltip} from '@gravity-ui/uikit'; | ||
|
||
import {block} from '../utils/cn'; | ||
|
||
import i18n from './i18n'; | ||
import {getCopyButtonSizeAndIconSize} from './utils'; | ||
|
||
import './PasswordInput.scss'; | ||
|
||
const b = block('password-input'); | ||
|
||
export type PasswordInputProps = Required<Pick<TextInputProps, 'onUpdate' | 'value'>> & | ||
Omit<TextInputProps, 'type'> & { | ||
/** Show copy button */ | ||
showCopyButton?: boolean; | ||
/** Show reveal button */ | ||
showRevealButton?: boolean; | ||
/** Disable the tooltip for the copy button. The tooltip will not be displayed */ | ||
hasCopyTooltip?: boolean; | ||
/** Disable the tooltip for the reveal button. The tooltip will not be displayed */ | ||
hasRevealTooltip?: boolean; | ||
}; | ||
|
||
export const PasswordInput: React.FC<PasswordInputProps> = (props) => { | ||
const { | ||
autoComplete, | ||
value, | ||
showCopyButton, | ||
rightContent, | ||
showRevealButton, | ||
size = 'm', | ||
hasCopyTooltip = true, | ||
hasRevealTooltip = true, | ||
controlProps, | ||
} = props; | ||
|
||
const [hideValue, setHideValue] = React.useState(true); | ||
|
||
const additionalRightContent = React.useMemo(() => { | ||
if (!showRevealButton && !showCopyButton) { | ||
return <React.Fragment>{rightContent}</React.Fragment>; | ||
} | ||
|
||
const onClick = () => { | ||
setHideValue((hideValue) => !hideValue); | ||
}; | ||
|
||
const {copyButtonSize, iconSize} = getCopyButtonSizeAndIconSize(size); | ||
|
||
return ( | ||
<div className={b('additional-right-content')}> | ||
{rightContent} | ||
{value && showCopyButton ? ( | ||
<ClipboardButton | ||
text={value} | ||
hasTooltip={hasRevealTooltip} | ||
size={iconSize} | ||
className={b('copy-button')} | ||
/> | ||
) : null} | ||
{showRevealButton ? ( | ||
<Tooltip | ||
disabled={!hasCopyTooltip} | ||
content={ | ||
hideValue ? i18n('label_show-password') : i18n('label_hide-password') | ||
} | ||
> | ||
<Button | ||
view="flat-secondary" | ||
onClick={onClick} | ||
size={copyButtonSize} | ||
extraProps={{ | ||
'aria-label': hideValue | ||
? i18n('label_show-password') | ||
: i18n('label_hide-password'), | ||
}} | ||
> | ||
<Icon data={hideValue ? Eye : EyeSlash} size={iconSize} /> | ||
</Button> | ||
</Tooltip> | ||
) : null} | ||
</div> | ||
); | ||
}, [ | ||
showRevealButton, | ||
showCopyButton, | ||
rightContent, | ||
value, | ||
hasRevealTooltip, | ||
hasCopyTooltip, | ||
hideValue, | ||
size, | ||
]); | ||
|
||
return ( | ||
<TextInput | ||
{...props} | ||
type={hideValue ? 'password' : 'text'} | ||
rightContent={additionalRightContent} | ||
autoComplete={autoComplete ? autoComplete : 'new-password'} | ||
controlProps={{ | ||
...controlProps, | ||
className: b('input-control', controlProps?.className), | ||
}} | ||
/> | ||
); | ||
}; |
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,35 @@ | ||
## PasswordInput | ||
|
||
Password Input display component | ||
|
||
### PropTypes | ||
|
||
Same as [TextInput component](https://github.com/gravity-ui/uikit/blob/main/src/components/controls/TextInput/README.md), with some exceptions: | ||
|
||
- `value` is required property; | ||
- `onUpdate` is required property; | ||
- `type` is omitted; | ||
|
||
| Property | Type | Required | Default | Description | | ||
| :--------------- | :-------- | :------- | :------ | :--------------------------------------------------------------------------- | | ||
| showCopyButton | `boolean` | | | Show copy button | | ||
| showRevealButton | `boolean` | | | Show reveal button | | ||
| hasCopyTooltip | `boolean` | | `true` | Disable the tooltip for the copy button. The tooltip will not be displayed | | ||
| hasRevealTooltip | `boolean` | | `true` | Disable the tooltip for the reveal button. The tooltip will not be displayed | | ||
|
||
#### Usage example | ||
|
||
```jsx harmony | ||
function MyComponent() { | ||
const [value, setValue] = React.useState(''); | ||
|
||
return ( | ||
<PasswordInput | ||
showCopyButton={true} | ||
showRevealButton={true} | ||
onUpdate={setValue} | ||
value={value} | ||
/> | ||
); | ||
} | ||
``` |
57 changes: 57 additions & 0 deletions
57
src/components/PasswordInput/__stories__/PasswordInput.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,57 @@ | ||
import React from 'react'; | ||
|
||
import {Button} from '@gravity-ui/uikit'; | ||
import type {Meta, StoryFn} from '@storybook/react'; | ||
|
||
import {cn} from '../../utils/cn'; | ||
import {PasswordInput, PasswordInputProps} from '../PasswordInput'; | ||
|
||
import './PasswordInputStories.scss'; | ||
|
||
const b = cn('password-input-stories'); | ||
|
||
export default { | ||
title: 'Components/PasswordInput', | ||
component: PasswordInput, | ||
args: { | ||
showCopyButton: true, | ||
showRevealButton: true, | ||
}, | ||
} as Meta; | ||
|
||
const DefaultTemplate: StoryFn<PasswordInputProps> = (args) => { | ||
const [value, setValue] = React.useState(''); | ||
|
||
return <PasswordInput {...args} onUpdate={setValue} value={value} />; | ||
}; | ||
|
||
export const Default = DefaultTemplate.bind({}); | ||
|
||
const WithGenerateRandomValueTemplate: StoryFn<PasswordInputProps> = (args) => { | ||
const [value, setValue] = React.useState(''); | ||
|
||
const generateRandomValue = React.useCallback(() => { | ||
let randomValue = ''; | ||
const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; | ||
const charactersLength = characters.length; | ||
let counter = 0; | ||
|
||
while (counter < charactersLength) { | ||
randomValue += characters.charAt(Math.floor(Math.random() * charactersLength)); | ||
counter += 1; | ||
} | ||
|
||
setValue(randomValue); | ||
}, []); | ||
|
||
return ( | ||
<div className={b()}> | ||
<PasswordInput {...args} onUpdate={setValue} value={value} /> | ||
<Button onClick={generateRandomValue} className={b('button-generate-random-value')}> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add prop |
||
Generate random value | ||
</Button> | ||
</div> | ||
); | ||
}; | ||
|
||
export const WithGenerateRandomValue = WithGenerateRandomValueTemplate.bind({}); |
7 changes: 7 additions & 0 deletions
7
src/components/PasswordInput/__stories__/PasswordInputStories.scss
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,7 @@ | ||
.password-input-stories { | ||
display: flex; | ||
|
||
&__button-generate-random-value { | ||
margin-left: 8px; | ||
} | ||
} |
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,4 @@ | ||
{ | ||
"label_show-password": "Show password", | ||
"label_hide-password": "Hide password" | ||
} |
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,8 @@ | ||
import {registerKeyset} from '../../utils/registerKeyset'; | ||
|
||
import en from './en.json'; | ||
import ru from './ru.json'; | ||
|
||
const COMPONENT = 'PasswordInput'; | ||
|
||
export default registerKeyset({en, ru}, COMPONENT); |
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,4 @@ | ||
{ | ||
"label_show-password": "Показать пароль", | ||
"label_hide-password": "Скрыть пароль" | ||
} |
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 './PasswordInput'; |
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,26 @@ | ||
import type {ButtonSize, InputControlSize} from '@gravity-ui/uikit'; | ||
|
||
export const getCopyButtonSizeAndIconSize = ( | ||
textInputSize: InputControlSize, | ||
): {copyButtonSize: ButtonSize; iconSize: number} => { | ||
let copyButtonSize: ButtonSize = 's'; | ||
let iconSize = 16; | ||
|
||
switch (textInputSize) { | ||
case 's': { | ||
copyButtonSize = 'xs'; | ||
iconSize = 12; | ||
break; | ||
} | ||
case 'l': { | ||
copyButtonSize = 'm'; | ||
break; | ||
} | ||
case 'xl': { | ||
copyButtonSize = 'l'; | ||
iconSize = 20; | ||
} | ||
} | ||
|
||
return {copyButtonSize, iconSize}; | ||
}; |
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spread should be before the className, otherwise it would be overwritten by the controlProps