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

Accessibility behavior tests and documentation generation #14968

Merged
merged 140 commits into from
Sep 30, 2020
Merged

Accessibility behavior tests and documentation generation #14968

merged 140 commits into from
Sep 30, 2020

Conversation

kolaps33
Copy link
Contributor

@kolaps33 kolaps33 commented Sep 10, 2020

Pull request checklist

  • Include a change request file using $ yarn change

Open questions/Future work

  • invoke click and keyboard event with testing libary - https://github.com/testing-library/user-event > can be implement in future after agreement inside the team
  • where should be "[behaviorName]Definition" files stored? so far the definition file is in the same folder where is "behavior" file
  • currently generating documentation from "behavior" file and from "definition" exists together.
    If documentation is not found in behavior file, then is generated from "definition" file. In the future generating doc from behavior file need to be removed.

Description of changes

This PR is coming out from the @mnajdova PR.
#14797

Purpose of the PR is to test "behavior" files and generate documentation from each behavior file based on the test.

In this PR following behaviors are tested:

  • buttonBehavior
  • buttonGroupBehavior
  • toggleButtonBehavior

This behaviors are now cover by test which stpes are in the "[behaviorName]Definition" file.

From "[behaviorName]Definition" file is as well documentation for each behavior file generated.

It doesn't change the documentation, only content under "description" paragraph is coming from "[behaviorName]Definition" file (pl. see screenshot below):
image

Focus areas to test

(optional)

mituron added 30 commits April 3, 2020 14:52
@ecraig12345
Copy link
Member

I think the build failure is because you need to add an alias in a tsconfig somewhere for @fluentui/a11y-testing since it's not within packages/fluentui. Try adding this under compilerOptions.paths in packages/fluentui/react-northstar/tsconfig.json: "@fluentui/a11y-testing": ["packages/a11y-testing/src"] (and if that doesn't work I'd recommend asking Shift or Miro if they can help figure out where to add it)

@khmakoto khmakoto added the Fluent UI react-northstar (v0) Work related to Fluent UI V0 label Sep 28, 2020
@kolaps33 kolaps33 merged commit 7fc8435 into microsoft:master Sep 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Fluent UI react-northstar (v0) Work related to Fluent UI V0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants