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

docs(PPDSC-2287): Grid layout documentation #335

Merged
merged 20 commits into from
Aug 22, 2022

Conversation

Srinivasan-Ramasamy
Copy link
Contributor

@Srinivasan-Ramasamy Srinivasan-Ramasamy commented Aug 16, 2022

PPDSC-2287

What

  1. Grid layout documentation UI - http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2287-grid-layout-documentation/components/grid-layout/
  2. Fix for ‘Grid’ page is also highlighted in the side nav.
  3. Stories: Merged part of this story - docs:(PPDSC-2066) grid-layout docs #174.

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

After:

image

Who should review this PR:

How to test:

URL: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2287-grid-layout-documentation/components/grid-layout/

@Srinivasan-Ramasamy Srinivasan-Ramasamy added docs Improvements or additions to documentation WIP Work in progress labels Aug 16, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy added the ready for design review Please assist in getting this reviewed label Aug 16, 2022
mutebg
mutebg previously approved these changes Aug 17, 2022
mutebg
mutebg previously approved these changes Aug 17, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy added ready for review Please assist in getting this reviewed and removed WIP Work in progress ready for design review Please assist in getting this reviewed labels Aug 17, 2022
{focusOrder && (
<A11yTable columns={['Order', 'Element', 'Role']} {...focusOrder} />
)}
{(focusOrder ||
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this change do?

Copy link
Contributor Author

@Srinivasan-Ramasamy Srinivasan-Ramasamy Aug 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mstuartf for reviewing the changes.

Actually this changes wants to avoid the extra empty space below the Accessibility section:
image

We're conditionally rendering the block to avoid the extra space here:
image

To match the figma design, we've updated this condition.

@Srinivasan-Ramasamy Srinivasan-Ramasamy merged commit 871d5ca into main Aug 22, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy deleted the docs/PPDSC-2287-grid-layout-documentation branch August 22, 2022 04:26
Xin00163 pushed a commit that referenced this pull request Oct 17, 2022
* docs(PPDSC-2287): Grid layout documentation page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation ready for review Please assist in getting this reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants