Skip to content
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(PasswordInput): add component #1745

Merged
merged 14 commits into from
Nov 15, 2024
16 changes: 16 additions & 0 deletions src/components/controls/PasswordInput/PasswordInput.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
@use '../../variables';

$block: '.#{variables.$ns}password-input';

#{$block} {
&__input-control {
&::-ms-reveal,
&::-ms-clear {
display: none;
}
}

&__copy-button {
margin-inline-end: 4px;
}
}
119 changes: 119 additions & 0 deletions src/components/controls/PasswordInput/PasswordInput.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
'use client';

import React from 'react';
ValeraS marked this conversation as resolved.
Show resolved Hide resolved

import {Eye, EyeSlash} from '@gravity-ui/icons';

import {useControlledState} from '../../../hooks';
import {ActionTooltip} from '../../ActionTooltip';
import {Button} from '../../Button';
import {ClipboardButton} from '../../ClipboardButton';
import {Icon} from '../../Icon';
import {block} from '../../utils/cn';
import {TextInput} from '../TextInput';
import type {TextInputProps} from '../TextInput';

import {i18n} from './i18n';
import {getActionButtonSizeAndIconSize} from './utils';

import './PasswordInput.scss';

const b = block('password-input');

export type PasswordInputProps = 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;
/** Determines the visibility state of the password input field */
revealValue?: boolean;
/** A callback function that is invoked whenever the revealValue state changes */
onRevealValueUpdate?: (value: boolean) => void;
};

export const PasswordInput = (props: PasswordInputProps) => {
ValeraS marked this conversation as resolved.
Show resolved Hide resolved
const {
autoComplete,
showCopyButton,
rightContent,
endContent,
showRevealButton,
size = 'm',
hasCopyTooltip = true,
hasRevealTooltip = true,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amje @korvin89 What do we want to do here, remove default values, rename props or do nothing?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest

  • to rename hasCopyTooltip to showCopyTooltip and remove default. I think there is no need in this element by default
  • to rename hasRevealTooltip to showRevealTooltip and remove default. I think we can hide this eleement by default

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

controlProps,
} = props;

const [inputValue, setInputValue] = useControlledState(
props.value,
props.defaultValue ?? '',
props.onUpdate,
);

const [revealValue, setRevealValue] = useControlledState(
props.revealValue,
false,
props.onRevealValueUpdate,
);

const {actionButtonSize, iconSize} = getActionButtonSizeAndIconSize(size);

const onClick: React.MouseEventHandler<HTMLButtonElement> = (event) => {
event.preventDefault();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preventDefault should be on mouse down

setRevealValue(!revealValue);
};

const additionalEndContent = (
<React.Fragment>
{endContent || rightContent}
{inputValue && showCopyButton && !props.disabled ? (
<ClipboardButton
view="flat-secondary"
text={inputValue}
hasTooltip={hasCopyTooltip}
size={actionButtonSize}
className={b('copy-button')}
/>
) : null}
{showRevealButton ? (
<ActionTooltip
disabled={!hasRevealTooltip}
title={revealValue ? i18n('label_hide-password') : i18n('label_show-password')}
>
<Button
view="flat-secondary"
ValeraS marked this conversation as resolved.
Show resolved Hide resolved
disabled={props.disabled}
onClick={onClick}
size={actionButtonSize}
extraProps={{
'aria-label': revealValue
? i18n('label_hide-password')
: i18n('label_show-password'),
}}
>
<Icon data={revealValue ? EyeSlash : Eye} size={iconSize} />
</Button>
</ActionTooltip>
) : null}
</React.Fragment>
);

return (
<TextInput
{...props}
type={revealValue ? 'text' : 'password'}
unstable_endContent={additionalEndContent}
autoComplete={autoComplete ? autoComplete : 'new-password'}
controlProps={{
...controlProps,
className: b('input-control', controlProps?.className),
}}
value={inputValue}
onUpdate={setInputValue}
/>
);
};
71 changes: 71 additions & 0 deletions src/components/controls/PasswordInput/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<!--GITHUB_BLOCK-->

## Password Input
amje marked this conversation as resolved.
Show resolved Hide resolved

<!--/GITHUB_BLOCK-->

```tsx
import {PasswordInput} from '@gravity-ui/uikit';
```

`TextInput` for typing passwords and other sensitive information. It can be rendered with copy and reveal buttons for more convinient usage.

### Copy button

The `showCopyButton` prop displays a "Copy" button next to the input field when a value is entered. This button allows users to easily copy the input value to their clipboard.

<!--LANDING_BLOCK
<ExampleBlock
code={` <PasswordInput showCopyButton={true} /> `}
>
<UIKit.PasswordInput showRevealButton={true} />
</ExampleBlock>
LANDING_BLOCK-->

### Reveal button

amje marked this conversation as resolved.
Show resolved Hide resolved
The `showRevealButton` prop allows users to toggle the visibility of the password.

<!--LANDING_BLOCK
<ExampleBlock
code={` <PasswordInput showRevealButton={true} /> `}
>
<UIKit.PasswordInput showRevealButton={true} />
</ExampleBlock>
LANDING_BLOCK-->

### Properties

`TextInput` [properties](/~https://github.com/gravity-ui/uikit/blob/main/src/components/controls/TextInput/README.md#properties), with some exceptions and additions:

- `type` is omitted;

| Name | Description | Type | Default |
| :------------------ | :--------------------------------------------------------------------------- | :--------: | :-----: |
| showCopyButton | Show copy button | `boolean` | `false` |
| showRevealButton | Show reveal button | `boolean` | `false` |
| hasCopyTooltip | Disable the tooltip for the copy button. The tooltip will not be displayed | `boolean` | `true` |
| hasRevealTooltip | Disable the tooltip for the reveal button. The tooltip will not be displayed | `boolean` | `true` |
| revealValue | Determines the visibility state of the password input field | `boolean` | `false` |
| onRevealValueUpdate | A callback function that is invoked whenever the revealValue state changes | `function` | |

<!--GITHUB_BLOCK-->

#### Usage example

```tsx
function MyComponent() {
const [value, setValue] = React.useState('');

return (
<PasswordInput
showCopyButton={true}
showRevealButton={true}
onUpdate={setValue}
value={value}
/>
);
}
```

<!--GITHUB_BLOCK-->
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions src/components/controls/PasswordInput/__stories__/Docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import {Meta, Markdown} from '@storybook/addon-docs';
import * as Stories from './PasswordInput.stories';
import Readme from '../README.md?raw';

<Meta of={Stories} />

<Markdown>{Readme}</Markdown>
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import React from 'react';

import type {Meta, StoryFn} from '@storybook/react';

import {Button} from '../../../Button';
import {Flex, spacing} from '../../../layout';
import type {PasswordInputProps} from '../PasswordInput';
import {PasswordInput} from '../PasswordInput';

export default {
title: 'Components/Inputs/PasswordInput',
component: PasswordInput,
args: {
showCopyButton: true,
showRevealButton: true,
controlProps: {
'aria-label': 'Password',
},
},
} as Meta<typeof PasswordInput>;

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 (
<Flex>
<PasswordInput {...args} onUpdate={setValue} value={value} />
<Flex className={spacing({ml: 2})}>
<Button onClick={generateRandomValue}>Generate random value</Button>
</Flex>
</Flex>
);
};

export const WithGenerateRandomValue = WithGenerateRandomValueTemplate.bind({});
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import React from 'react';

import {test} from '~playwright/core';

import {PasswordInputStories} from './helpersPlaywright';

test.describe('PasswordInput', () => {
test('render story: <Default>', async ({mount, expectScreenshot}) => {
await mount(<PasswordInputStories.Default />);

await expectScreenshot();
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import {composeStories} from '@storybook/react';

import * as DefaultPasswordInputStories from '../__stories__/PasswordInput.stories';

export const PasswordInputStories = composeStories(DefaultPasswordInputStories);
4 changes: 4 additions & 0 deletions src/components/controls/PasswordInput/i18n/en.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label_show-password": "Show password",
"label_hide-password": "Hide password"
}
8 changes: 8 additions & 0 deletions src/components/controls/PasswordInput/i18n/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import {addComponentKeysets} from '../../../../i18n';

import en from './en.json';
import ru from './ru.json';

const COMPONENT = 'PasswordInput';

export const i18n = addComponentKeysets({en, ru}, COMPONENT);
4 changes: 4 additions & 0 deletions src/components/controls/PasswordInput/i18n/ru.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label_show-password": "Показать пароль",
"label_hide-password": "Скрыть пароль"
}
1 change: 1 addition & 0 deletions src/components/controls/PasswordInput/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './PasswordInput';
26 changes: 26 additions & 0 deletions src/components/controls/PasswordInput/utils.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import type {ButtonSize} from '../../Button';
import type {InputControlSize} from '../types';

export const getActionButtonSizeAndIconSize = (
textInputSize: InputControlSize,
): {actionButtonSize: ButtonSize; iconSize: number} => {
let actionButtonSize: ButtonSize = 's';
let iconSize = 16;

switch (textInputSize) {
case 's': {
actionButtonSize = 'xs';
iconSize = 12;
break;
}
case 'l': {
actionButtonSize = 'm';
break;
}
case 'xl': {
actionButtonSize = 'l';
}
}

return {actionButtonSize, iconSize};
};
1 change: 1 addition & 0 deletions src/components/controls/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './TextArea';
export * from './TextInput';
export * from './PasswordInput';
export type {InputControlPin, InputControlSize, InputControlState, InputControlView} from './types';
Loading