feat: Visibility toggle for PasswordInput (#377)

* Update fuselage.d.ts

* Update index.js

* Update spec.js

* Update index.js

* Update fuselage.d.ts

* Update index.js

* Update spec.js

* Update PasswordInput.stories.mdx

* Invert toggle state icon

* Convert PasswordInput to TypeScript

Co-authored-by: gabriellsh <40830821+gabriellsh@users.noreply.github.com>
Co-authored-by: Tasso Evangelista <tasso.evangelista@rocket.chat>

Author: 3 people

packages/fuselage-hooks/src/useToggle.ts

@@ -1,9 +1,4 @@
-import {
-  useState,
-  DispatchWithoutAction,
-  Dispatch,
-  SetStateAction,
-} from 'react';
+import { useState, SetStateAction } from 'react';
 
 import { useMutableCallback } from './useMutableCallback';
 
@@ -14,11 +9,9 @@ import { useMutableCallback } from './useMutableCallback';
  * @returns a state boolean value and a state toggler function
  * @public
  */
-export const useToggle = <
-  D extends DispatchWithoutAction | Dispatch<SetStateAction<boolean>>
->(
+export const useToggle = (
   initialValue?: boolean | (() => boolean)
-): [boolean, D] => {
+): [boolean, (forcedValue?: SetStateAction<boolean>) => void] => {
   const [value, setValue] = useState(() => {
     if (typeof initialValue === 'function') {
       return !!initialValue();
@@ -27,23 +20,22 @@ export const useToggle = <
     return !!initialValue;
   });
 
-  const dispatch = useMutableCallback<
-    D extends DispatchWithoutAction ? [] : [SetStateAction<boolean>],
-    void
-  >((forcedValue?: SetStateAction<boolean>) => {
-    // uses value from scope to avoid multiple toggles in one render cycle
-    setValue(() => {
-      if (typeof forcedValue === 'boolean') {
-        return forcedValue;
-      }
+  const dispatch = useMutableCallback(
+    (forcedValue?: SetStateAction<boolean>) => {
+      // uses value from scope to avoid multiple toggles in one render cycle
+      setValue(() => {
+        if (typeof forcedValue === 'boolean') {
+          return forcedValue;
+        }
 
-      if (typeof forcedValue === 'function') {
-        return forcedValue(value);
-      }
+        if (typeof forcedValue === 'function') {
+          return forcedValue(value);
+        }
 
-      return !value;
-    });
-  }) as D;
+        return !value;
+      });
+    }
+  );
 
   return [value, dispatch];
 };

packages/fuselage/.loki/reference/chrome_iphone7_Forms_Inputs_PasswordInput_Default.png

@@ -1,7 +1,7 @@
 import React from 'react';
 import ReactDOM from 'react-dom';
 
-import { PasswordInput } from '.';
+import PasswordInput from '.';
 
 it('renders without crashing', () => {
   const div = document.createElement('div');

packages/fuselage/.loki/reference/chrome_iphone7_Forms_Inputs_PasswordInput_Disabled.png

@@ -0,0 +1,51 @@
+import { Meta, Story } from '@storybook/react';
+import React from 'react';
+
+import { Icon, PasswordInput } from '../..';
+import PropsVariation from '../../.storybook/PropsVariation';
+
+export default {
+  title: 'Forms/Inputs/PasswordInput',
+  component: PasswordInput,
+  parameters: { jest: ['PasswordInput.spec.tsx'] },
+} as Meta;
+
+export const Default: Story = () => <PasswordInput />;
+
+export const WithValue: Story = () => <PasswordInput defaultValue='password' />;
+
+export const WithIconAddon: Story = () => (
+  <PasswordInput addon={<Icon name='send' size={20} />} />
+);
+
+export const Invalid: Story = () => <PasswordInput error='Error' />;
+
+export const Disabled: Story = () => <PasswordInput disabled />;
+
+export const WithPlaceholder: Story = () => (
+  <PasswordInput placeholder='Placeholder' />
+);
+
+export const States: Story = () => (
+  <PropsVariation
+    component={PasswordInput}
+    common={{ onChange: () => undefined }}
+    xAxis={{
+      'default': {},
+      'with placeholder': { placeholder: 'Placeholder' },
+      'with value': { value: 'Value' },
+      'with icon': { addon: <Icon name='key' size='x20' />, value: 'Value' },
+    }}
+    yAxis={{
+      'default': {},
+      'hover': { className: 'hover' },
+      'active': { className: 'active' },
+      'focus': { className: 'focus' },
+      'disabled': { disabled: true },
+      'errored': { error: 'Error' },
+      'errored + hover': { className: 'hover', error: 'Error' },
+      'errored + active': { className: 'active', error: 'Error' },
+      'errored + focus': { className: 'focus', error: 'Error' },
+    }}
+  />
+);

packages/fuselage/.loki/reference/chrome_iphone7_Forms_Inputs_PasswordInput_Invalid.png

@@ -0,0 +1,36 @@
+import { useToggle } from '@rocket.chat/fuselage-hooks';
+import React, { ComponentProps, forwardRef, Ref } from 'react';
+
+import { Icon } from '../Icon';
+import { InputBox } from '../InputBox';
+
+// TODO: fix a11y issues
+
+type PasswordInputProps = Omit<ComponentProps<typeof InputBox>, 'type'>;
+
+const PasswordInput = forwardRef(function PasswordInput(
+  props: PasswordInputProps,
+  ref: Ref<HTMLInputElement>
+) {
+  const [hidden, toggle] = useToggle(true);
+  const handleAddonClick = () => {
+    toggle();
+  };
+
+  return (
+    <InputBox
+      type={hidden ? 'password' : 'text'}
+      addon={
+        <Icon
+          name={hidden ? 'eye-off' : 'eye'}
+          size={20}
+          onClick={handleAddonClick}
+        />
+      }
+      ref={ref}
+      {...props}
+    />
+  );
+});
+
+export default PasswordInput;

packages/fuselage/.loki/reference/chrome_iphone7_Forms_Inputs_PasswordInput_States.png

@@ -0,0 +1 @@
+export { default } from './PasswordInput';

packages/fuselage/.loki/reference/chrome_iphone7_Forms_Inputs_PasswordInput_With_Placeholder.png

@@ -26,7 +26,7 @@ export * from './NumberInput';
 export * from './Options';
 export * from './Options/Option';
 export * from './Pagination';
-export * from './PasswordInput';
+export { default as PasswordInput } from './PasswordInput';
 export * from './StatusBullet';
 export * from './ProgressBar';
 export * from './RadioButton';