Docs(822) Card Composable doc site #876

jannuk59 · 2023-05-05T08:18:17Z

closes #822

What

Background - why this is needed
What did you do
What does the reviewers should expect

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:

pp-serviceaccount · 2023-05-05T08:38:43Z

You can preview these changes on:
Documentation Site: http://ncu-newskit-docs-pr.s3-website-eu-west-1.amazonaws.com/822-card-composable-doc-site
Storybook: http://ncu-newskit-docs-pr.s3-website-eu-west-1.amazonaws.com/822-card-composable-doc-site/storybook

mutebg · 2023-05-17T08:58:44Z

site/pages/components/card-composable.tsx

+              attribute: 'paddingBlockStart',
+              type: 'MQ<string>',
+              default: '',
+              description:
+                'Takes one space token to specify the logical block start padding of the container. Can be used on breakpoints',
+            },
+            {
+              attribute: 'paddingBlockEnd',
+              type: 'MQ<string>',
+              default: '',
+              description:
+                'Takes one space token to specify the logical block end padding of the container. Can be used on breakpoints',
+            },


All padding and margin can be deleted, since commonLogicalProps() function is doing the same

mutebg · 2023-05-17T09:01:55Z

site/pages/components/card-composable.tsx

+        {
+          title: 'CardActions',
+          summary:
+            'Props and Overrides same as GridLayout + can have stylePreset and transitionPreset as an override',


I would delete this summary and add props & overrides same way as CardComposable component

mutebg · 2023-05-18T08:27:59Z

site/pages/components/card-composable.tsx

+          summary:
+            'Props and Overrides same as CardComposable + can have stylePreset and transitionPreset as an override',


Remove this one

mutebg · 2023-05-18T08:28:10Z

site/pages/components/card-composable.tsx

+          summary:
+            'Props and Overrides same as CardComposable component + can have stylePreset and transitionPreset as an override',


Remove this one

mutebg · 2023-05-18T08:28:29Z

site/pages/components/card-composable.tsx

+          summary:
+            'Props and Overrides same as CardComposable component + can have stylePreset and transitionPreset as an override',


Remove this one

site/pages/components/card-composable.tsx

mutebg · 2023-05-18T11:31:40Z

site/pages/components/card-composable.tsx

+            {
+              name: 'rowGap',
+              type: 'MQ<string>',
+              description: 'If provided, applies rowGap to the grid',
+              required: null,
+            },
+            {
+              name: 'columnGap',
+              type: 'MQ<string>',
+              description: 'If provided, applies columnGap to the grid',
+              required: null,
+            },
+            {


can you store all these props and overrides in consts so that they can be re-used across all components?
Also, CardComposable needs same props.
Apart from that, everything else seems good and ready for approval, thank you

Done @mutebg . Please have a review on it

mutebg · 2023-05-19T06:51:05Z

site/pages/components/card-composable.tsx

-              name: 'media',
-              type: 'ImageProps',
-              required: undefined,
-              description:
-                'If this parameter is provided as ImageProps object (see Image documentation), it will render the media as an image.',
-            },


You need to reverse the media prop

mutebg · 2023-05-19T06:53:41Z

site/pages/components/card-composable.tsx

-              description: 'If provided, overrides the minHeight of the grid',
+              attribute: 'stylePreset',
+              type: 'MQ<String>',
+              default: 'cardContainer',


CardAction does not have default stylePreset and transitionPreset

mutebg · 2023-05-19T06:57:32Z

site/pages/components/card-composable.tsx

+            {
+              attribute: 'stylePreset',
+              type: 'MQ<String>',
+              default: 'cardContainer',


CardContent does not have default stylePreset and transitionPreset

mutebg · 2023-05-19T06:57:48Z

site/pages/components/card-composable.tsx

+            {
+              attribute: 'stylePreset',
+              type: 'MQ<String>',
+              default: 'cardContainer',
+              description:
+                'If provided, overrides the stylePreset of the card.',
+            },
+            {
+              attribute: 'transitionPreset',
+              type: 'String | String[]',
+              default: 'backgroundColorChange',
+              description: '',
+            },


CardMedia does not have default stylePreset and transitionPreset

mutebg · 2023-05-19T06:58:39Z

site/pages/components/card-composable.tsx

+                  still be added before or after the LinkStandalone component.
+                </>
+              ),
+            },


you need to add expand prop

Ravindren added 5 commits May 4, 2023 11:48

docs(822): card composable doc site

4f4ba5c

docs(822): added illustrations

037b362

docs(822): doc corrections

b7a4efa

docs(822): accessibility fixes

2ea8a0e

docs(822): components api fixes

101f449

github-actions bot added the docs Improvements or additions to documentation label May 5, 2023

Ravindren added 2 commits May 5, 2023 13:49

docs(822): components api fixes

0873559

docs(822): unordered list fixes

952dcd7

docs(822): added the title to leftside menubar

6719342

jannuk59 added ready for design review Please assist in getting this reviewed draft This is a draft PR and not intended for formal review yet labels May 5, 2023

Ravindren added 10 commits May 5, 2023 14:31

docs(822): storybook changes

20614b6

docs(822): design feedback fix

e973b39

docs(723): removed themeing

fe9b172

docs(822): expand prop

ec2cc7e

docs(822): unordered list inline alignment fix

205c2dc

docs(822): added link for the grid layour

9bc4600

docs(822): added grid layout component in related component

5d1c8d2

docs(822): added grid layout component in related component

ff9757f

docs(822): snapshot update

572d5f1

docs(723): removed typograpghy

8fc720d

jannuk59 added ready for review Please assist in getting this reviewed and removed draft This is a draft PR and not intended for formal review yet ready for design review Please assist in getting this reviewed labels May 15, 2023

jannuk59 marked this pull request as ready for review May 15, 2023 13:00

mutebg suggested changes May 17, 2023

View reviewed changes

Ravindren added 3 commits May 17, 2023 16:48

docs(822): removed padding and margin props row

a18998c

docs(822): content change for props row

336b0f6

docs(822): content change for props row

38bc336

mutebg suggested changes May 18, 2023

View reviewed changes

Ravindren added 3 commits May 18, 2023 15:19

docs(822): remomed props row

4777c69

docs(822): added props and overrides for cardLink

b377f2f

docs(822): added props and overrides for all the components

1044cad

mutebg suggested changes May 18, 2023

View reviewed changes

Ravindren added 3 commits May 18, 2023 17:29

docs(822): grouping the props into const

76ef106

docs(822): grouped the props into consts

0f0cc1e

docs(822): refinement

0b88c2a

mutebg reviewed May 19, 2023

View reviewed changes

Ravindren added 3 commits May 19, 2023 13:08

docs(822): props and overrides

aa33101

docs(822): removed stylepreset and transitionPreset

dc1df16

docs(822): removed stylepreset and transitionPreset

b39c24b

mutebg approved these changes May 19, 2023

View reviewed changes

JohnTParsons approved these changes May 19, 2023

View reviewed changes

jannuk59 merged commit 335b02c into main May 19, 2023

jannuk59 deleted the docs/822-card-composable-doc-site branch May 19, 2023 09:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs(822) Card Composable doc site #876

Docs(822) Card Composable doc site #876

jannuk59 commented May 5, 2023 •

edited by mutebg

Loading

pp-serviceaccount commented May 5, 2023

mutebg May 17, 2023

mutebg May 17, 2023

mutebg May 18, 2023

mutebg May 18, 2023

mutebg May 18, 2023

mutebg May 18, 2023

jannuk59 May 18, 2023

mutebg May 19, 2023

mutebg May 19, 2023

mutebg May 19, 2023

mutebg May 19, 2023

mutebg May 19, 2023

		summary:
		'Props and Overrides same as CardComposable + can have stylePreset and transitionPreset as an override',

Docs(822) Card Composable doc site #876

Docs(822) Card Composable doc site #876

Conversation

jannuk59 commented May 5, 2023 • edited by mutebg Loading

pp-serviceaccount commented May 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jannuk59 commented May 5, 2023 •

edited by mutebg

Loading