ESLint plugin

The essential plugin for use with the Atlassian Design System.

use-simple-field

Simple field implementations should be used when extended features or complex implementations are not needed.

Examples

This rule marks code as a violation when it finds Design System field components that have:

no render props or there’s only fieldProps
no messaging components.

Incorrect

import { Field } from '@atlaskit/form';
import TextField from '@atlaskit/textfield';

<Field name="username" label="Username">
    {({ fieldProps }) => <TextField {...fieldProps} />}
</Field>;

Correct

import { Field } from '@atlaskit/form';
import TextField from '@atlaskit/textfield';

<Field
    name="username"
    label="Username"
    component={({ fieldProps }) => <TextField {...fieldProps} />}
/>;

Was this page helpful?

We use this feedback to improve our documentation.