@fluentui/react-conformance NPM | npm.io

0.19.0 • Published 2 days ago

Install

Weekly downloads

2

License

MIT

Repository

Last release

2 days ago

@fluentui/react-conformance

A tool used to run standardized tests which follow Fluent UI React's component guidelines. It also can be extended and allows for adding your own conformance tests.

Configuration

isConformant ( base configuration )

Add isConformant within your package and configure any globally applied test options.

my-proj/
├─ common/
│  ├─ isConformant.ts 👈
├─ src/
├─ node_modules/
├─ package.json

import { isConformant as baseIsConformant } from '@fluentui/react-conformance';
import type { IsConformantOptions } from '@fluentui/react-conformance';

export function isConformant<TProps = {}>(
  testInfo: Omit<IsConformantOptions<TProps>, 'componentPath'> & { componentPath?: string },
) {
  const defaultOptions: Partial<IsConformantOptions<TProps>> = {
    componentPath: require.main?.filename.replace('.test', ''),
    // 👆 Put any required test options here ( ex: componentPath, asPropHandlesRef, ... )
  };

  baseIsConformant(defaultOptions, testInfo);
}

isConformant ( running tests )

Within your component's test file:

my-proj/
├─ common/
├─ src/
│  ├─ components
│  │  ├─ Foo
│  │  │  ├─ ...
│  │  │  ├─ Foo.test 👈
├─ node_modules/
├─ package.json

Import the isConformant file that you just created:

import { isConformant } from '../../common/isConformant';

describe('Foo', () => {
  isConformant({
    Component: Foo,
    displayName: 'Foo',
    disabledTests: [],
    // 👆 For tests that don't fit the guidelines of your component you can disable them.
  });
});

isConformant with React Portals

By default isConformant inspects a component's immediate parent container. Because React Portals are typically rendered outside this container components using Portals will fail conformance. For example the component-has-static-classnames-object tests inspect the rendered DOM for certain class names but, with default settings, will fail for anything rendered into a Portal.

Portals can be inspected by providing a getTargetElement function to isConformant.

// Assume that `Foo` is a component that renders a Portal.
// It takes a prop called `idForPortal` that renders the
// provided id in the Portal, allowing it to be looked up
// via `getPortalElement()`.

const getPortalElement = (result, attr) => {
  return result.baseElement.querySelector("#portal-id");
};

describe('Foo', () => {
  isConformant({
    Component: Foo,
    displayName: 'Foo'
    requiredProps: { idForPortal: "portal-id" },
    getTargetElement: getPortalElement
  });
});

lodash chalk react-docgen-typescript react-is @swc/helpers

@everything-registry/sub-chunk-330 @zalastax/nolb-_flu

0.0.0-nightly-20240502-0405.1

2 days ago

0.0.0-nightly-20240501-0406.1

3 days ago

0.0.0-nightly-20240430-0406.1

4 days ago

0.0.0-nightly-20240429-0407.1

5 days ago

0.0.0-nightly-20240426-0405.1

8 days ago

0.0.0-nightly-20240425-0408.1

9 days ago

0.0.0-nightly-20240424-0405.1

10 days ago

0.0.0-nightly-20240423-0406.1

11 days ago

0.0.0-nightly-20240422-0407.1

12 days ago

0.0.0-nightly-20240419-0408.1

15 days ago

0.0.0-nightly-20240418-0406.1

16 days ago

0.0.0-nightly-20240417-0406.1

17 days ago

0.0.0-nightly-20240416-0406.1

18 days ago

0.0.0-nightly-20240412-0405.1

22 days ago

0.0.0-nightly-20240415-0407.1

19 days ago

0.0.0-nightly-20240411-0405.1

23 days ago

0.0.0-nightly-20240410-0406.1

24 days ago

0.0.0-nightly-20240409-0405.1

25 days ago

0.0.0-nightly-20240408-0406.1

26 days ago

0.0.0-nightly-20240405-0409.1

29 days ago

0.0.0-nightly-20240404-0406.1

30 days ago

0.0.0-nightly-20240402-0405.1

1 month ago

0.0.0-nightly-20240403-0405.1

1 month ago

0.0.0-nightly-20240401-0408.1

1 month ago

0.0.0-nightly-20240329-0405.1

1 month ago

0.0.0-nightly-20240328-0407.1

1 month ago

0.0.0-nightly-20240327-0404.1

1 month ago

0.0.0-nightly-20240326-0405.1

1 month ago

0.0.0-nightly-20240325-0409.1

1 month ago

0.0.0-nightly-20240322-0406.1

1 month ago

0.0.0-nightly-20240321-0406.1

1 month ago

0.0.0-nightly-20240320-0406.1

1 month ago

0.0.0-nightly-20240319-0405.1

2 months ago

0.0.0-nightly-20240318-0408.1

2 months ago

0.0.0-nightly-20240315-0408.1

2 months ago

0.0.0-nightly-20240312-0405.1

2 months ago

0.0.0-nightly-20240314-0406.1

2 months ago

0.0.0-nightly-20240313-0405.1

2 months ago

0.0.0-nightly-20240311-0406.1

2 months ago

0.0.0-nightly-20240308-0405.1

2 months ago

0.0.0-nightly-20240307-0406.1

2 months ago

0.0.0-nightly-20240306-0405.1

2 months ago

0.0.0-nightly-20240305-1651.1

2 months ago

0.0.0-nightly-20240305-0405.1

2 months ago

0.0.0-nightly-20240304-0405.1

2 months ago

0.0.0-nightly-20240301-0405.1

2 months ago

0.0.0-nightly-20240229-0406.1

2 months ago

0.0.0-nightly-20240228-0405.1

2 months ago

0.0.0-nightly-20240226-0407.1

2 months ago

0.0.0-nightly-20240227-0405.1

2 months ago

0.0.0-nightly-20240222-0407.1

2 months ago

0.0.0-nightly-20240223-0405.1

2 months ago

2 months ago

0.0.0-nightly-20240221-0405.1

2 months ago

0.0.0-nightly-20240220-0405.1

2 months ago

0.0.0-nightly-20240219-0407.1

2 months ago

0.0.0-nightly-20240216-0405.1

3 months ago

0.0.0-nightly-20240215-0406.1

3 months ago

0.0.0-nightly-20240214-0405.1

3 months ago

0.0.0-nightly-20240213-0403.1

3 months ago

0.0.0-nightly-20240212-0406.1

3 months ago

0.0.0-nightly-20240209-0405.1

3 months ago

0.0.0-nightly-20240208-0405.1

3 months ago

0.0.0-nightly-20240207-0406.1

3 months ago

0.0.0-nightly-20240206-0405.1

3 months ago

0.0.0-nightly-20240205-0406.1

3 months ago

0.0.0-nightly-20240202-0405.1

3 months ago

0.0.0-nightly-20240201-0407.1

3 months ago

0.0.0-nightly-20240131-0406.1

3 months ago

0.0.0-nightly-20240129-0407.1

3 months ago

0.0.0-nightly-20240125-0407.1

3 months ago

0.0.0-nightly-20240126-0405.1

3 months ago

0.0.0-nightly-20240124-0406.1

3 months ago

0.0.0-nightly-20240123-0405.1

3 months ago

0.0.0-nightly-20240122-0406.1

3 months ago

0.0.0-nightly-20240119-0406.1

4 months ago

0.0.0-nightly-20240118-0405.1

4 months ago

0.0.0-nightly-20240117-0405.1

4 months ago

0.0.0-nightly-20240116-0406.1

4 months ago

0.0.0-nightly-20240115-0407.1

4 months ago

0.0.0-nightly-20240111-0405.1

4 months ago

0.0.0-nightly-20240112-0405.1

4 months ago

0.0.0-nightly-20240110-0406.1

4 months ago

0.0.0-nightly-20240109-0405.1

4 months ago

0.0.0-nightly-20240108-0406.1

4 months ago

0.0.0-nightly-20240105-0405.1

4 months ago

0.0.0-nightly-20240104-0405.1

4 months ago

0.0.0-nightly-20240103-0406.1

4 months ago

0.0.0-nightly-20240101-0406.1

4 months ago

0.0.0-nightly-20231229-0405.1

4 months ago

0.0.0-nightly-20231228-0406.1

4 months ago

0.0.0-nightly-20231226-0405.1

4 months ago

0.0.0-nightly-20231227-0406.1

4 months ago

0.0.0-nightly-20231225-0406.1

4 months ago

0.0.0-nightly-20231222-0405.1

4 months ago

0.0.0-nightly-20231221-0406.1

4 months ago

0.0.0-nightly-20231220-0405.1

5 months ago

0.0.0-nightly-20231219-0407.1

5 months ago

0.0.0-nightly-20231218-0406.1

5 months ago

0.0.0-nightly-20231215-0405.1

5 months ago

0.0.0-nightly-20231214-0405.1

5 months ago

0.0.0-nightly-20231213-0405.1

5 months ago

0.0.0-nightly-20231212-0405.1

5 months ago

0.0.0-nightly-20231211-0406.1

5 months ago

0.0.0-nightly-20231208-0405.1

5 months ago

0.0.0-nightly-20231207-0407.1

5 months ago

0.0.0-nightly-20231206-0406.1

5 months ago

0.0.0-nightly-20231205-0406.1

5 months ago

0.0.0-nightly-20230831-0414.1

8 months ago

0.0.0-nightly-20230822-0416.1

9 months ago

0.0.0-nightly-20230703-0415.1

10 months ago

0.0.0-nightly-20230705-0413.1

10 months ago

0.0.0-nightly-20230712-0413.1

10 months ago

8 months ago

0.0.0-nightly-20230802-0414.1

9 months ago

0.0.0-nightly-20230713-0416.1

10 months ago

0.0.0-nightly-20230809-0415.1

9 months ago

0.0.0-nightly-20230818-0413.1

9 months ago

0.0.0-nightly-20230803-0413.1

9 months ago

0.0.0-nightly-20230825-0413.1

8 months ago

10 months ago

0.0.0-nightly-20230913-0415.1

8 months ago

0.0.0-nightly-20231117-0406.1

6 months ago

0.0.0-nightly-20231020-0415.1

7 months ago

0.0.0-nightly-20231027-0413.1

6 months ago

0.0.0-nightly-20230907-0414.1

8 months ago

0.0.0-nightly-20231006-0415.1

7 months ago

0.0.0-nightly-20230721-0415.1

10 months ago

0.0.0-nightly-20231113-0406.1

6 months ago

0.0.0-nightly-20231025-0415.1

6 months ago

0.0.0-nightly-20230731-0416.1

9 months ago

0.0.0-nightly-20230726-0415.1

9 months ago

0.0.0-nightly-20231129-0405.1

5 months ago

0.0.0-nightly-20230922-0418.1

7 months ago

0.0.0-nightly-20231127-0407.1

5 months ago

0.0.0-nightly-20230728-0413.1

9 months ago

0.0.0-nightly-20230830-0414.1

8 months ago

0.0.0-nightly-20230707-0414.1

10 months ago

0.0.0-nightly-20230706-0415.1

10 months ago

7 months ago

7 months ago

6 months ago

0.0.0-nightly-20230710-0414.1

10 months ago

0.0.0-nightly-20231005-0415.1

7 months ago

0.0.0-nightly-20231003-0415.1

7 months ago

0.0.0-nightly-20231004-0414.1

7 months ago

0.0.0-nightly-20230814-0416.1

9 months ago

0.0.0-nightly-20230817-0413.1

9 months ago

8 months ago

0.0.0-nightly-20230915-0416.1

8 months ago

0.0.0-nightly-20230912-0416.1

8 months ago

0.0.0-nightly-20231114-0405.1

6 months ago

0.0.0-nightly-20231106-0406.1

6 months ago

0.0.0-nightly-20231110-0405.1

6 months ago

0.0.0-nightly-20231102-0406.1

6 months ago

0.0.0-nightly-20231023-0416.1

6 months ago

0.0.0-nightly-20231101-0406.1

6 months ago

0.0.0-nightly-20231115-0405.1

6 months ago

0.0.0-nightly-20231107-0406.1

6 months ago

0.0.0-nightly-20230929-0415.1

7 months ago

0.0.0-nightly-20231103-0406.1

6 months ago

0.0.0-nightly-20231016-0417.1

7 months ago

0.0.0-nightly-20230927-0415.1

7 months ago

0.0.0-nightly-20230920-0415.1

8 months ago

0.0.0-nightly-20230829-0415.1

8 months ago

0.0.0-nightly-20230810-0415.1

9 months ago

0.0.0-nightly-20230704-0416.1

10 months ago

0.0.0-nightly-20231201-0406.1

5 months ago

0.0.0-nightly-20230714-0413.1

10 months ago

0.0.0-nightly-20230811-0414.1

9 months ago

0.0.0-nightly-20231204-0407.1

5 months ago

0.0.0-nightly-20231002-0417.1

7 months ago

0.0.0-nightly-20230807-0415.1

9 months ago

0.0.0-nightly-20230919-0415.1

8 months ago

0.0.0-nightly-20231031-0414.1

6 months ago

0.0.0-nightly-20230918-0417.1

8 months ago

0.0.0-nightly-20231109-0405.1

6 months ago

0.0.0-nightly-20231108-0405.1

6 months ago

0.0.0-nightly-20231019-0416.1

7 months ago

0.0.0-nightly-20231120-0407.1

6 months ago

0.0.0-nightly-20231018-0416.1

7 months ago

0.0.0-nightly-20230926-0416.1

7 months ago

0.0.0-nightly-20230925-0416.1

7 months ago

0.0.0-nightly-20231024-0413.1

6 months ago

0.0.0-nightly-20230724-0415.1

9 months ago

0.0.0-nightly-20230727-0415.1

9 months ago

0.0.0-nightly-20230725-0413.1

9 months ago

0.0.0-nightly-20231101-1848.1

6 months ago

0.0.0-nightly-20230901-0414.1

8 months ago

0.0.0-nightly-20230905-0414.1

8 months ago

0.0.0-nightly-20230921-0416.1

8 months ago

0.0.0-nightly-20231128-0407.1

5 months ago

0.0.0-nightly-20230828-0417.1

8 months ago

0.0.0-nightly-20230824-0417.1

8 months ago

0.0.0-nightly-20231030-0406.1

6 months ago

0.0.0-nightly-20230821-0414.1

9 months ago

0.0.0-nightly-20230801-0416.1

9 months ago

0.0.0-nightly-20230720-0415.1

10 months ago

0.0.0-nightly-20230711-0415.1

10 months ago

0.0.0-nightly-20230804-0415.1

9 months ago

0.0.0-nightly-20231012-0415.1

7 months ago

0.0.0-nightly-20231010-0415.1

7 months ago

0.0.0-nightly-20230815-0415.1

9 months ago

0.0.0-nightly-20231011-0416.1

7 months ago

0.0.0-nightly-20231116-0411.1

6 months ago

0.0.0-nightly-20230823-0414.1

8 months ago

0.0.0-nightly-20230816-0414.1

9 months ago

0.0.0-nightly-20230808-0415.1

9 months ago

0.0.0-nightly-20231028-0053.1

6 months ago

0.0.0-nightly-20231026-0414.1

6 months ago

0.0.0-nightly-20230911-0418.1

8 months ago

0.0.0-nightly-20230906-0415.1

8 months ago

0.0.0-nightly-20231124-0406.1

5 months ago

0.0.0-nightly-20231123-0406.1

5 months ago

0.0.0-nightly-20231122-0406.1

5 months ago

0.0.0-nightly-20231121-0406.1

5 months ago

0.0.0-nightly-20231013-0415.1

7 months ago

0.0.0-nightly-20231028-2304.1

6 months ago

0.0.0-nightly-20231017-0415.1

7 months ago

0.0.0-nightly-20230908-0415.1

8 months ago

0.0.0-nightly-20231130-0405.1

5 months ago

0.0.0-nightly-20231009-0416.1

7 months ago

0.0.0-nightly-20230928-0417.1

7 months ago

0.0.0-nightly-20230718-0415.1

10 months ago

0.0.0-nightly-20230630-0414.1

10 months ago

0.0.0-nightly-20230719-0415.1

10 months ago

0.0.0-nightly-20230717-0415.1

10 months ago

0.0.0-nightly-20230904-0415.1

8 months ago

11 months ago

0.0.0-nightly-20230619-0417.1

11 months ago

0.0.0-nightly-20230627-0414.1

10 months ago

0.0.0-nightly-20230626-0414.1

10 months ago

0.0.0-nightly-20230623-0414.1

11 months ago

0.0.0-nightly-20230622-0414.1

11 months ago

0.0.0-nightly-20230620-0414.1

11 months ago

0.0.0-nightly-20230621-0414.1

11 months ago

11 months ago

1 year ago

1 year ago

11 months ago

11 months ago

1 year ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago