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

[Feature] Character counter for TextInput and Textarea #752

Merged
merged 17 commits into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/core/Form/TextInput/TextInput.baseStyles.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@ export const baseStyles = (theme: SuomifiTheme) => css`
${font(theme)('bodyText')}
width: 290px;

& .fi-text-input_character-counter {
${font(theme)('bodyTextSmall')};
color: ${theme.colors.blackBase};
font-size: 14px;
line-height: 20px;
flex: none;
margin-top: 4px;

&.fi-text-input_character-counter--error {
color: ${theme.colors.alertBase};
${font(theme)('bodySemiBoldSmall')};
font-size: 14px;
line-height: 20px;
}
}

& .fi-text-input_bottom-wrapper {
display: flex;
justify-content: space-between;
}

& .fi-text-input_wrapper {
width: 100%;
display: inline-block;
Expand Down
46 changes: 46 additions & 0 deletions src/core/Form/TextInput/TextInput.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,49 @@ import { IconMapLocation } from 'suomifi-icons';
/>
</>;
```

### TextInput with character counter

```js
import { TextInput } from 'suomifi-ui-components';
import React, { useState } from 'react';

const [isError, setIsError] = useState(false);
const [statusText, setStatusText] = useState('');

const maxCharAmount = 20;

/**
* Check if maximum amount of characters has exceed, and set status and statusText accordingly.
* You can also add any other desired input validation rules here.
*/
const validateText = (text) => {
if (text.length > maxCharAmount) {
setIsError(true);
setStatusText('Description must be 20 characters or less');
} else {
setIsError(false);
setStatusText('');
}
};

<>
<TextInput
hintText="Please provide details pertaining to the case"
labelText="Description"
onChange={(value) => validateText(value)}
characterLimit={maxCharAmount}
ariaCharactersRemainingText={(amount) =>
`You have ${amount} characters remaining`
}
ariaCharactersExceededText={(amount) =>
`You have ${amount} characters too many`
}
statusText={statusText}
status={isError ? 'error' : 'default'}
fullWidth
debounce={300}
defaultValue="Lorem ipsum dolor"
></TextInput>
</>;
```
34 changes: 34 additions & 0 deletions src/core/Form/TextInput/TextInput.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -304,3 +304,37 @@ describe('props', () => {
});
});
});

describe('Character counter', () => {
it('should display correct character count', () => {
const { container, getByRole } = render(
<TextInput
labelText="label"
defaultValue="Lorem ipsum"
characterLimit={20}
ariaCharactersRemainingText={(amount) =>
`You have ${amount} characters remaining`
}
ariaCharactersExceededText={(amount) =>
`You have ${amount} characters too many`
}
/>,
);
expect(
container.getElementsByClassName('fi-text-input_character-counter')
.length,
).toBe(1);
expect(
container.getElementsByClassName('fi-text-input_character-counter')[0],
).toHaveTextContent('11/20');

const textInput = getByRole('textbox') as HTMLTextAreaElement;
fireEvent.change(textInput, {
target: { value: 'Lorem ipsum dolor sit amet' },
});

expect(
container.getElementsByClassName('fi-text-input_character-counter')[0],
).toHaveTextContent('26/20');
});
});
Loading