Merge branch 'textarea-counter' into 'develop'

Textarea: add a character counter

See merge request soapbox-pub/soapbox!2373

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Reactions: Support custom emoji reactions
 - Compatbility: Support Mastodon v2 timeline filters.
 - Posts: Support dislikes on Friendica.
+- UI: added a character counter to some textareas.
 
 ### Changed
 - Posts: truncate Nostr pubkeys in reply mentions.

app/soapbox/components/ui/textarea/textarea.tsx

@@ -1,5 +1,9 @@
 import clsx from 'clsx';
 import React, { useState } from 'react';
+import { FormattedMessage } from 'react-intl';
+
+import Stack from '../stack/stack';
+import Text from '../text/text';
 
 interface ITextarea extends Pick<React.TextareaHTMLAttributes<HTMLTextAreaElement>, 'maxLength' | 'onChange' | 'onKeyDown' | 'onPaste' | 'required' | 'disabled' | 'rows' | 'readOnly'> {
   /** Put the cursor into the input on mount. */
@@ -28,6 +32,8 @@ interface ITextarea extends Pick<React.TextareaHTMLAttributes<HTMLTextAreaElemen
   isResizeable?: boolean
   /** Textarea theme. */
   theme?: 'default' | 'transparent'
+  /** Whether to display a character counter below the textarea. */
+  withCounter?: boolean
 }
 
 /** Textarea with custom styles. */
@@ -40,8 +46,11 @@ const Textarea = React.forwardRef(({
   maxRows = 10,
   minRows = 1,
   theme = 'default',
+  maxLength,
+  value,
   ...props
 }: ITextarea, ref: React.ForwardedRef<HTMLTextAreaElement>) => {
+  const length = value?.length || 0;
   const [rows, setRows] = useState<number>(autoGrow ? 1 : 4);
 
   const handleChange = (event: React.ChangeEvent<HTMLTextAreaElement>) => {
@@ -70,20 +79,35 @@ const Textarea = React.forwardRef(({
   };
 
   return (
-    <textarea
+    <Stack space={1.5}>
-      {...props}
+      <textarea
-      ref={ref}
+        {...props}
-      rows={rows}
+        value={value}
-      onChange={handleChange}
+        ref={ref}
-      className={clsx('block w-full rounded-md text-gray-900 placeholder:text-gray-600 dark:text-gray-100 dark:placeholder:text-gray-600 sm:text-sm', {
+        rows={rows}
-        'bg-white dark:bg-transparent shadow-sm border-gray-400 dark:border-gray-800 dark:ring-1 dark:ring-gray-800 focus:ring-primary-500 focus:border-primary-500 dark:focus:ring-primary-500 dark:focus:border-primary-500':
+        onChange={handleChange}
-          theme === 'default',
+        className={clsx('block w-full rounded-md text-gray-900 placeholder:text-gray-600 dark:text-gray-100 dark:placeholder:text-gray-600 sm:text-sm', {
-        'bg-transparent border-0 focus:border-0 focus:ring-0': theme === 'transparent',
+          'bg-white dark:bg-transparent shadow-sm border-gray-400 dark:border-gray-800 dark:ring-1 dark:ring-gray-800 focus:ring-primary-500 focus:border-primary-500 dark:focus:ring-primary-500 dark:focus:border-primary-500':
-        'font-mono': isCodeEditor,
+            theme === 'default',
-        'text-red-600 border-red-600': hasError,
+          'bg-transparent border-0 focus:border-0 focus:ring-0': theme === 'transparent',
-        'resize-none': !isResizeable,
+          'font-mono': isCodeEditor,
-      })}
+          'text-red-600 border-red-600': hasError,
-    />
+          'resize-none': !isResizeable,
+        })}
+      />
+
+      {maxLength && (
+        <div className='text-right rtl:text-left'>
+          <Text size='xs' theme={maxLength - length < 0 ? 'danger' : 'muted'}>
+            <FormattedMessage
+              id='textarea.counter.label'
+              defaultMessage='{count} characters remaining'
+              values={{ count: maxLength - length }}
+            />
+          </Text>
+        </div>
+      )}
+    </Stack>
   );
 },
 );

app/soapbox/features/auth-login/components/registration-form.tsx

@@ -28,6 +28,7 @@ const messages = defineMessages({
   newsletter: { id: 'registration.newsletter', defaultMessage: 'Subscribe to newsletter.' },
   needsConfirmationHeader: { id: 'confirmations.register.needs_confirmation.header', defaultMessage: 'Confirmation needed' },
   needsApprovalHeader: { id: 'confirmations.register.needs_approval.header', defaultMessage: 'Approval needed' },
+  reasonHint: { id: 'registration.reason_hint', defaultMessage: 'This will help us review your application' },
 });
 
 interface IRegistrationForm {
@@ -296,13 +297,14 @@ const RegistrationForm: React.FC<IRegistrationForm> = ({ inviteToken }) => {
           {needsApproval && (
             <FormGroup
               labelText={<FormattedMessage id='registration.reason' defaultMessage='Why do you want to join?' />}
-              hintText={<FormattedMessage id='registration.reason_hint' defaultMessage='This will help us review your application' />}
             >
               <Textarea
                 name='reason'
+                placeholder={intl.formatMessage(messages.reasonHint)}
                 maxLength={500}
                 onChange={onInputChange}
                 value={params.get('reason', '')}
+                autoGrow
                 required
               />
             </FormGroup>

app/soapbox/locales/en.json

@@ -1481,6 +1481,7 @@
   "tabs_bar.profile": "Profile",
   "tabs_bar.search": "Search",
   "tabs_bar.settings": "Settings",
+  "textarea.counter.label": "{count} characters remaining",
   "theme_editor.Reset": "Reset",
   "theme_editor.export": "Export theme",
   "theme_editor.import": "Import theme",