docs(PPDSC-2381): Tag documentation #402

RashikaNewsUK · 2022-10-07T12:43:33Z

PPDSC-2381

What

1.Tag 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:

newskit-engineering · 2022-10-07T12:53:53Z

You can preview these changes on:
Documentation Site: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2381-tag-documentation
Storybook: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2381-tag-documentation/storybook

cypress/site/functional/section-navigation.spec.js

mstuartf · 2022-10-11T09:19:03Z

site/pages/components/tag.tsx

+    name: 'disabled',
+    type: 'boolean',
+    default: 'false',
+    description: 'If true, renders the undefined tag in a disabled state.',


What does undefined mean in this context? Might be a question for Mike M.

Hi @mstuartf,
I have removed the word "undefined" from the API section. Could you please take look and confirm.

Thanks,
Rashika.

site/components/illustrations/components/tag/behaviours/fixedandfullwidth.tsx

site/pages/components/tag.tsx

mutebg · 2022-10-17T07:19:31Z

site/pages/components/tag.tsx

+  {
+    name: 'eventOriginator',
+    type: 'string',
+    default: 'tag',
+    description: 'Allows users to add event originator custom name.',
+  },


The Tag does not support the event originator yet, better remove that part

I have removed the event originator form the api section. -thanks!

site/pages/components/tag.tsx

mutebg · 2022-10-17T07:21:28Z

site/pages/components/tag.tsx

+    description: 'If provided, overrides the stylePreset of the tag.',
+  },
+  {
+    attribute: 'tag.typographyPreset',


Suggested change

attribute: 'tag.typographyPreset',

attribute: 'typographyPreset',

site/pages/components/tag.tsx

mutebg · 2022-10-17T07:26:27Z

site/pages/components/tag.tsx

+      "If provided, overrides the padding of the tag. Otherwise, use spaceInsetSquish010 or spaceInsetSquish020, depending on the 'size' prop.",
+  },
+  {
+    attribute: 'tag.spaceInline',


Suggested change

attribute: 'tag.spaceInline',

attribute: 'spaceInline',

mutebg · 2022-10-17T07:26:55Z

site/pages/components/tag.tsx

+  {
+    attribute: 'tag.spaceInline',
+    type: 'MQ<string>',
+    default: ['small = space010', 'medium = space010', 'large = space020'],


Suggested change

default: ['small = space010', 'medium = space010', 'large = space020'],

default: ['small = space010', 'medium = space010', 'large = space010'],

Done. Modified the large value. -thanks!

mutebg · 2022-10-17T07:27:13Z

site/pages/components/tag.tsx

+      'If provided, overrides the space between multiple children in the underlying stack.',
+  },
+  {
+    attribute: 'tag.icon.size',


Suggested change

attribute: 'tag.icon.size',

attribute: 'iconSize',

mutebg · 2022-10-17T07:27:49Z

site/pages/components/tag.tsx

+  {
+    attribute: 'tag.icon.size',
+    type: 'MQ<string>',
+    default: ['small = space010', 'medium = space010', 'large = space020'],


Suggested change

default: ['small = space010', 'medium = space010', 'large = space020'],

default: ['small = iconSize010', 'medium = iconSize010', 'large = iconSize020'],

Done. Modified the default values. -thanks!

mutebg · 2022-10-17T07:29:23Z

site/pages/components/tag.tsx

+              {
+                label: 'Style Preset',
+                value: {
+                  stylePreset: 'tagCustom',


tagCustom does not exist try with:

Suggested change

stylePreset: 'tagCustom',

stylePreset: 'tagPrimaryInverse',

Done. Modified the stylePreset value. -thanks!

RashikaNewsUK and others added 4 commits October 6, 2022 12:46

docs(PPDSC-2381): tag documentation

4069944

docs(PPDSC-2381): removing unused files

af4c3e7

docs(PPDSC-2381): review changes

b9d8784

docs(PPDSC-2381): demo section fixes

edc6914

RashikaNewsUK added docs Improvements or additions to documentation ready for design review Please assist in getting this reviewed labels Oct 7, 2022

RashikaNewsUK requested review from jps, Xin00163, pdimova, baburay23, mutebg, Vanals, evgenitsn and Srinivasan-Ramasamy as code owners October 7, 2022 12:43

RashikaNewsUK and others added 11 commits October 7, 2022 18:30

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

f3370bf

docs(PPDSC-2381): removed unwanted file

14ace1f

docs(PPDSC-2381): removed unwanted file

04101ff

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

e2f6558

docs(PPDSC-2381): try fix for build fail

acc44ff

docs(PPDSC-2381): revert fix

becae32

docs(PPDSC-2381): feedback changes

94df170

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

0349689

docs(PPDSC-2381): cypress code fix for build fail

73a6b96

docs(PPDSC-2381): revert cypress code fix for build fail

ad46db1

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

a28fba8

RashikaNewsUK added ready for review Please assist in getting this reviewed and removed ready for design review Please assist in getting this reviewed labels Oct 11, 2022

docs(PPDSC-2381): build fail fix

780687a

mstuartf reviewed Oct 11, 2022

View reviewed changes

Srinivasan-Ramasamy and others added 2 commits October 12, 2022 10:36

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

f732328

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

6fe53cb

RashikaNewsUK requested a review from mstuartf October 13, 2022 06:47

RashikaNewsUK and others added 3 commits October 13, 2022 19:17

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

9f9cea7

docs(PPDSC-2381): updated api section

0bd8c49

docs(PPDSC-2381): removed undefined text from the api section

7eb258b

Vanals reviewed Oct 14, 2022

View reviewed changes

site/components/illustrations/components/tag/behaviours/fixedandfullwidth.tsx Outdated Show resolved Hide resolved

RashikaNewsUK and others added 5 commits October 14, 2022 18:36

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

01390f8

docs(PPDSC-2381): modified file name

0f4a894

docs(PPDSC-2381): modified file name

1df22d4

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

784921f

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

360ee36

RashikaNewsUK requested a review from Vanals October 17, 2022 05:59

mutebg suggested changes Oct 17, 2022

View reviewed changes

docs(PPDSC-2381): modified api section

aba3afa

RashikaNewsUK requested a review from mutebg October 17, 2022 11:31

mutebg approved these changes Oct 17, 2022

View reviewed changes

Vanals approved these changes Oct 17, 2022

View reviewed changes

Merge branch 'main' into docs/PPDSC-2381-tag-documentation

ad1e564

Srinivasan-Ramasamy approved these changes Oct 17, 2022

View reviewed changes

RashikaNewsUK merged commit b086685 into main Oct 18, 2022

RashikaNewsUK deleted the docs/PPDSC-2381-tag-documentation branch October 18, 2022 04:54

RashikaNewsUK added ready to merge please assist in getting this merged and removed ready for review Please assist in getting this reviewed labels Oct 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(PPDSC-2381): Tag documentation #402

docs(PPDSC-2381): Tag documentation #402

RashikaNewsUK commented Oct 7, 2022 •

edited

Loading

newskit-engineering commented Oct 7, 2022

mstuartf Oct 11, 2022

RashikaNewsUK Oct 14, 2022

mutebg Oct 17, 2022

RashikaNewsUK Oct 17, 2022

mutebg Oct 17, 2022

mutebg Oct 17, 2022

mutebg Oct 17, 2022

RashikaNewsUK Oct 17, 2022

mutebg Oct 17, 2022

mutebg Oct 17, 2022

RashikaNewsUK Oct 17, 2022

mutebg Oct 17, 2022

RashikaNewsUK Oct 17, 2022

	attribute: 'tag.typographyPreset',
	attribute: 'typographyPreset',

	default: ['small = space010', 'medium = space010', 'large = space020'],
	default: ['small = space010', 'medium = space010', 'large = space010'],

	default: ['small = space010', 'medium = space010', 'large = space020'],
	default: ['small = iconSize010', 'medium = iconSize010', 'large = iconSize020'],

docs(PPDSC-2381): Tag documentation #402

docs(PPDSC-2381): Tag documentation #402

Conversation

RashikaNewsUK commented Oct 7, 2022 • edited Loading

newskit-engineering commented Oct 7, 2022

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

Choose a reason for hiding this comment

RashikaNewsUK commented Oct 7, 2022 •

edited

Loading