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-2346): Grid cell documentation #420

Merged
merged 20 commits into from
Oct 28, 2022

Conversation

RashikaNewsUK
Copy link
Contributor

PPDSC-2346

What

1.Grid-Cell documentation UI.

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:

Who should review this PR:

How to test:

@RashikaNewsUK RashikaNewsUK added ready for review Please assist in getting this reviewed and removed Requires design review labels Oct 20, 2022
import {UsageKind} from '../../components/usage-card';
import {ContentText} from '../../components/text-section/content-text';

const commonOverridesRows = [
Copy link
Contributor

Choose a reason for hiding this comment

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

The Grid does not have overrides, thtese are just props

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @mutebg , Overrides has been removed. Please have a look on it. -thanks!

summary:
'The grid has a range of props that can be used to define an appropriate experience for different use cases.',
propsRows: [
{
Copy link
Contributor

Choose a reason for hiding this comment

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

maxWidth prop is missing,
type: string
default: 1920px

summary: `The cell has a range of props that can be used to define an appropriate experience for different use cases.`,
propsRows: [
{
name: 'Root',
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
name: 'Root',
name: 'children',

Comment on lines 382 to 395
{
name: 'xs span',
type: [
'xsHidden',
'smHidden',
'mdHidden',
'lgHidden',
'xlHidden',
],
default: '',
description:
'The children of a column are rendered in that column, any supported React node is allowed.',
required: true,
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Tihs does not seems correct, we have the following props:

  xs?: number | 'full-width';
  sm?: number | 'full-width';
  md?: number | 'full-width';
  lg?: number | 'full-width';
  xl?: number | 'full-width';

  xsHidden?: boolean;
  smHidden?: boolean;
  mdHidden?: boolean;
  lgHidden?: boolean;
  xlHidden?: boolean;

  xsOrder?: number;
  smOrder?: number;
  mdOrder?: number;
  lgOrder?: number;
  xlOrder?: number;

  xsOffset?: number;
  smOffset?: number;
  mdOffset?: number;
  lgOffset?: number;
  xlOffset?: number;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @mutebg ,
All the changes has been done. Please have a look on it.
Thanks,
Rashika

@RashikaNewsUK RashikaNewsUK requested a review from mutebg October 26, 2022 07:49
/>
);

const commonPropsRows = [
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const commonPropsRows = [
const gridPropsRows = [

},
{
title: 'Cell',
summary: `The cell has a range of props that can be used to define an appropriate experience for different use cases.`,
propsRows: [
{
name: 'Root',
name: 'Children',
Copy link
Contributor

Choose a reason for hiding this comment

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

lowercase

Suggested change
name: 'Children',
name: 'children',

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @mutebg ,
changes has been done, Please have a look on it. -thanks!

@RashikaNewsUK RashikaNewsUK requested a review from mutebg October 26, 2022 14:41
@RashikaNewsUK RashikaNewsUK merged commit 4457afc into main Oct 28, 2022
@RashikaNewsUK RashikaNewsUK deleted the docs/PPDSC-2346-grid-cell-documentation branch October 28, 2022 10:28
@RashikaNewsUK RashikaNewsUK removed the ready for review Please assist in getting this reviewed label Oct 28, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants