fix: corrected comments

gravity-ui · Oct 30, 2023 · 868a5ac · 868a5ac
1 parent 110608c
commit 868a5ac
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 34 deletions.
diff --git a/src/components/PasswordInput/PasswordInput.scss b/src/components/PasswordInput/PasswordInput.scss
@@ -3,9 +3,11 @@
 $block: '.#{variables.$ns}password-input';
 
 #{$block} {
-    &::-ms-reveal,
-    &::-ms-clear {
-        display: none;
+    &__input-control {
+        &::-ms-reveal,
+        &::-ms-clear {
+            display: none;
+        }
     }
 
     &__additional-right-content {

diff --git a/src/components/PasswordInput/PasswordInput.tsx b/src/components/PasswordInput/PasswordInput.tsx
@@ -1,11 +1,12 @@
 import React from 'react';
 
 import {Eye, EyeSlash} from '@gravity-ui/icons';
-import {Button, ClipboardButton, TextInput, TextInputProps, Tooltip} from '@gravity-ui/uikit';
+import {Button, ClipboardButton, Icon, TextInput, TextInputProps, Tooltip} from '@gravity-ui/uikit';
 
 import {block} from '../utils/cn';
 
 import i18n from './i18n';
+import {getCopyButtonSizeAndIconButtonSize} from './utils';
 
 import './PasswordInput.scss';
 
@@ -17,8 +18,10 @@ export type PasswordInputProps = Required<Pick<TextInputProps, 'onUpdate' | 'val
         showCopyButton?: boolean;
         /** Show reveal button */
         showRevealButton?: boolean;
-        /** Disable tooltip. Tooltip won't be shown */
-        hasTooltip?: 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) => {
@@ -29,7 +32,9 @@ export const PasswordInput: React.FC<PasswordInputProps> = (props) => {
         rightContent,
         showRevealButton,
         size = 'm',
-        hasTooltip = true,
+        hasCopyTooltip = true,
+        hasRevealTooltip = true,
+        controlProps,
     } = props;
 
     const [hideValue, setHideValue] = React.useState(true);
@@ -43,41 +48,52 @@ export const PasswordInput: React.FC<PasswordInputProps> = (props) => {
             setHideValue((hideValue) => !hideValue);
         };
 
+        const {copyButtonSize, iconSize} = getCopyButtonSizeAndIconButtonSize(size);
+
         return (
             <div className={b('additional-right-content')}>
                 {rightContent}
                 {value && showCopyButton ? (
                     <ClipboardButton
                         text={value}
-                        hasTooltip={hasTooltip}
-                        size={16}
+                        hasTooltip={hasRevealTooltip}
+                        size={iconSize}
                         className={b('copy-button')}
                     />
                 ) : null}
                 {showRevealButton ? (
                     <Tooltip
-                        disabled={!hasTooltip}
+                        disabled={!hasCopyTooltip}
                         content={
                             hideValue ? i18n('label_show-password') : i18n('label_hide-password')
                         }
                     >
                         <Button
                             view="flat-secondary"
                             onClick={onClick}
-                            size={size}
+                            size={copyButtonSize}
                             extraProps={{
                                 'aria-label': hideValue
                                     ? i18n('label_show-password')
                                     : i18n('label_hide-password'),
                             }}
                         >
-                            <Button.Icon>{hideValue ? <Eye /> : <EyeSlash />}</Button.Icon>
+                            <Icon data={hideValue ? Eye : EyeSlash} size={iconSize} />
                         </Button>
                     </Tooltip>
                 ) : null}
             </div>
         );
-    }, [showRevealButton, showCopyButton, rightContent, value, hasTooltip, hideValue, size]);
+    }, [
+        showRevealButton,
+        showCopyButton,
+        rightContent,
+        value,
+        hasRevealTooltip,
+        hasCopyTooltip,
+        hideValue,
+        size,
+    ]);
 
     return (
         <TextInput
@@ -86,7 +102,8 @@ export const PasswordInput: React.FC<PasswordInputProps> = (props) => {
             rightContent={additionalRightContent}
             autoComplete={autoComplete ? autoComplete : 'new-password'}
             controlProps={{
-                className: b(),
+                className: b('input-control', controlProps?.className),
+                ...controlProps,
             }}
         />
     );

diff --git a/src/components/PasswordInput/README.md b/src/components/PasswordInput/README.md
@@ -10,11 +10,12 @@ Same as [TextInput component](https://github.com/gravity-ui/uikit/blob/main/src/
 - `onUpdate` is required property;
 - `type` is omitted;
 
-| Property         | Type      | Required | Default | Description                             |
-| :--------------- | :-------- | :------- | :------ | :-------------------------------------- |
-| showCopyButton   | `boolean` |          |         | Show copy button                        |
-| showRevealButton | `boolean` |          |         | Show reveal button                      |
-| hasTooltip       | `boolean` |          | `true`  | Disable tooltip. Tooltip won't be shown |
+| 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
 
@@ -25,7 +26,7 @@ function MyComponent() {
   return (
     <PasswordInput
       showCopyButton={true}
-      showVisibilityButton={true}
+      showRevealButton={true}
       onUpdate={setValue}
       value={value}
     />

diff --git a/src/components/PasswordInput/__stories__/PasswordInput.stories.tsx b/src/components/PasswordInput/__stories__/PasswordInput.stories.tsx
@@ -4,7 +4,7 @@ import {Button} from '@gravity-ui/uikit';
 import type {Meta, StoryFn} from '@storybook/react';
 
 import {cn} from '../../utils/cn';
-import {PasswordInput} from '../PasswordInput';
+import {PasswordInput, PasswordInputProps} from '../PasswordInput';
 
 import './PasswordInputStories.scss';
 
@@ -13,26 +13,21 @@ const b = cn('password-input-stories');
 export default {
     title: 'Components/PasswordInput',
     component: PasswordInput,
+    args: {
+        showCopyButton: true,
+        showRevealButton: true,
+    },
 } as Meta;
 
-const DefaultTemplate: StoryFn<React.ComponentProps<typeof PasswordInput>> = () => {
+const DefaultTemplate: StoryFn<PasswordInputProps> = (args) => {
     const [value, setValue] = React.useState('');
 
-    return (
-        <PasswordInput
-            showCopyButton={true}
-            showRevealButton={true}
-            onUpdate={setValue}
-            value={value}
-        />
-    );
+    return <PasswordInput {...args} onUpdate={setValue} value={value} />;
 };
 
 export const Default = DefaultTemplate.bind({});
 
-const WithGenerateRandomValueTemplate: StoryFn<React.ComponentProps<typeof PasswordInput>> = (
-    props: React.ComponentProps<typeof PasswordInput>,
-) => {
+const WithGenerateRandomValueTemplate: StoryFn<PasswordInputProps> = (args) => {
     const [value, setValue] = React.useState('');
 
     const generateRandomValue = React.useCallback(() => {
@@ -51,7 +46,7 @@ const WithGenerateRandomValueTemplate: StoryFn<React.ComponentProps<typeof Passw
 
     return (
         <div className={b()}>
-            <PasswordInput {...props} onUpdate={setValue} value={value} />
+            <PasswordInput {...args} onUpdate={setValue} value={value} />
             <Button onClick={generateRandomValue} className={b('button-generate-random-value')}>
                 Generate random value
             </Button>

diff --git a/src/components/PasswordInput/utils.ts b/src/components/PasswordInput/utils.ts
@@ -0,0 +1,26 @@
+import type {ButtonSize, InputControlSize} from '@gravity-ui/uikit';
+
+export const getCopyButtonSizeAndIconButtonSize = (
+    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};
+};