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 2552 content updates #557

Merged
merged 13 commits into from
Jan 17, 2023
24 changes: 12 additions & 12 deletions site/components/component-api/common-logical-props.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,65 +6,65 @@ export const logicalMarginOverrideProps: OverridesRowsProps[] = [
{
attribute: 'marginInline',
type: 'MQ<string>',
description: `Can take one space token to specify the logical inline start and end margin of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical inline start and end margin of the container. Can be used on breakpoints`,
},
{
attribute: 'marginInlineStart',
type: 'MQ<string>',
description: `Can take one space token to specify the logical inline start margin of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical inline start margin of the container. Can be used on breakpoints`,
},
{
attribute: 'marginInlineEnd',
type: 'MQ<string>',
description: `Can take one space token to specify the logical inline end margin of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical inline end margin of the container. Can be used on breakpoints`,
},
{
attribute: 'marginBlock',
type: 'MQ<string>',
description: `Can take one space token to specify the logical block start and end margin of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical block start and end margin of the container. Can be used on breakpoints`,
},
{
attribute: 'marginBlockStart',
type: 'MQ<string>',
description: `Can take one space token to specify the logical block start margin of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical block start margin of the container. Can be used on breakpoints`,
},
{
attribute: 'marginBlockEnd',
type: 'MQ<string>',
description: `Can take one space token to specify the logical block end margin of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical block end margin of the container. Can be used on breakpoints`,
},
];

export const logicalPaddingOverrideProps: OverridesRowsProps[] = [
{
attribute: 'paddingInline',
type: 'MQ<string>',
description: `Can take one space token to specify the logical inline start and end padding of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical inline start and end padding of the container. Can be used on breakpoints`,
},
{
attribute: 'paddingInlineStart',
type: 'MQ<string>',
description: `Can take one space token to specify the logical inline start padding of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical inline start padding of the container. Can be used on breakpoints`,
},
{
attribute: 'paddingInlineEnd',
type: 'MQ<string>',
description: `Can take one space token to specify the logical inline end padding of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical inline end padding of the container. Can be used on breakpoints`,
},
{
attribute: 'paddingBlock',
type: 'MQ<string>',
description: `Can take one space token to specify the logical block start and end padding of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical block start and end padding of the container. Can be used on breakpoints`,
},
{
attribute: 'paddingBlockStart',
type: 'MQ<string>',
description: `Can take one space token to specify the logical block start padding of the container. Can be used on breakpoints`,
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>',
description: `It can take Can take one space token to specify the logical block end padding of the container. Can be used on breakpoints`,
description: `Takes one space token to specify the logical block end padding of the container. Can be used on breakpoints`,
},
];

Expand Down
2 changes: 1 addition & 1 deletion site/pages/components/accordion.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ const AccordionComponent = (layoutProps: LayoutProps) => (
},
}}
seo={{
title: 'SEO Considerations',
title: 'SEO considerations',
introduction: (
<UnorderedList
markerAlign="start"
Expand Down
2 changes: 1 addition & 1 deletion site/pages/components/banner.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ const BannerComponent = (layoutProps: LayoutProps) => (
},
}}
seo={{
title: 'SEO Considerations',
title: 'SEO considerations',
introduction: 'There are no SEO considerations for this component.',
}}
componentAPI={{
Expand Down
74 changes: 40 additions & 34 deletions site/pages/components/block.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const BlockComponent = (layoutProps: LayoutProps) => (
headTags={{
title: 'Block',
description:
'The Block is a simple container component that style and space can be applied to. This is the equivalent to a frame in Figma.',
'Blocks are simple container components that you can apply style and space to. They’re the equivalent of frames in Figma.',
}}
layoutProps={layoutProps}
pageIntroduction={{
Expand All @@ -32,7 +32,7 @@ const BlockComponent = (layoutProps: LayoutProps) => (
illustration: 'components/block-illustration',
},
introduction:
'The Block is a simple container component that style and space can be applied to. This is the equivalent to a frame in Figma.',
'Blocks are simple container components that you can apply style and space to. They’re the equivalent of frames in Figma.',
}}
componentDefaultsKey="Block"
meta={{
Expand All @@ -45,7 +45,7 @@ const BlockComponent = (layoutProps: LayoutProps) => (
}}
interactiveDemo={{
introduction:
'This demo allows you to preview the Block component, its variations, and configuration options.',
'This demo lets you preview the block component, its variations and configuration options.',
playground: {
componentName: 'Block',
component: (props: BlockProps) => (
Expand Down Expand Up @@ -135,7 +135,7 @@ const BlockComponent = (layoutProps: LayoutProps) => (
},
}}
anatomy={{
introduction: 'The Block contains one element.',
introduction: 'The block contains one required element.',
rows: [
{
name: 'Block',
Expand All @@ -147,52 +147,58 @@ const BlockComponent = (layoutProps: LayoutProps) => (
}),
}}
options={{
introduction:
'The Block has options that can be used to provide an appropriate experience for different use cases.',
introduction: 'The block has options for different use cases:',
cards: [
{
title: 'Render as',
description:
'By using Render as, the block can be converted to a ‘span’.',
description: 'Convert the block to a ‘span’.',
media: getIllustrationComponent('components/block/render-as'),
},
{
title: 'Style',
description:
'Styling can be applied to the block by using style presets.',
description: (
<>
Apply styling to the block with{' '}
<Link href="https://www.newskit.co.uk/theme/presets/style-presets/">
style presets
</Link>{' '}
.
</>
),
media: getIllustrationComponent('components/block/style'),
},
{
title: 'Spacing',
description:
'Three types of spacing can be applied to the block; spaceInline, spaceStack, and spaceInset.',
'Apply three types of spacing to the block: space inline, space stack and space inset.',
media: getIllustrationComponent('components/block/spacing'),
},
],
}}
usage={{
introduction:
'The following guidance describes how and when to appropriately use the Block.',
introduction: 'Here’s how and when to use the block:',
cards: [
{
title: 'Use the block to apply spacing and style presets',
description:
'Use the Block as a container to easily apply spacing and style presets around other elements.',
'Use the block as a container to easily apply spacing and style presets around other elements.',
kind: UsageKind.DO,
media: getIllustrationComponent('components/block/do-01'),
},
{
title: 'Don’t use for equal spacing on multiple elements',
description: (
<>
Avoid using the Block component when equal spacing needs to be
applied to multiple elements. In this case, the{' '}
Avoid using the block when you need to apply equal spacing to
multiple elements. Use{' '}
<Link href="https://www.newskit.co.uk/components/stack/">
Stack
</Link>
component, or the{' '}
stack
</Link>{' '}
or{' '}
<Link href="https://www.newskit.co.uk/components/grid/">
Grid{' '}
grid{' '}
</Link>
component should be used.
instead.
</>
),
kind: UsageKind.DONT,
Expand All @@ -203,21 +209,21 @@ const BlockComponent = (layoutProps: LayoutProps) => (
accessibility={{
introduction: (
<>
As this is an HTML element, this component can utilise any aria
attribute, such as region. See more details{' '}
The block is an HTML element, so you can use any ARIA attribute (e.g.
region).{' '}
<Link href="https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA">
here
Learn more ARIA at MDN Web Docs
</Link>
.
</>
),
}}
seo={{
title: 'SEO Considerations',
introduction: 'There are no SEO considerations for this component.',
title: 'SEO considerations',
introduction: 'There are no SEO considerations for the block.',
}}
componentAPI={{
introduction: `The Block has a range of props that can be used to define an appropriate experience for different use cases.`,
introduction: `The block has a range of props to define the experience in different use cases.`,
components: [
{
title: 'Block',
Expand All @@ -226,39 +232,39 @@ const BlockComponent = (layoutProps: LayoutProps) => (
name: ' as',
type: 'string',
default: 'div',
description: `If provided, renders the Block as this element. e.g span.`,
description: `If provided, renders the block as this element (e.g span)`,
},
{
name: 'stylePreset',
type: 'MQ<string>',
description: `If provided, applies style on the Block.`,
description: `If provided, applies style on the block`,
},
{
name: 'spaceInline(deprecated)',
type: 'MQ<string>',
description: `Use marginInlineEnd instead. Set the spacing which is applied as a margin on the right of the Block.`,
description: `Use marginInlineEnd instead. Set the spacing which is applied as a margin on the right of the block`,
},
{
name: 'spaceStack(deprecated)',
type: 'MQ<string>',
description: `Use marginBlockEnd instead. This is a spacing preset token which is applied as a margin on the bottom of the Block. Use this to space stacking content down the page.`,
description: `Use marginBlockEnd instead. This is a spacing preset token which is applied as a margin on the bottom of the block. Use to space stack content down the page`,
},
{
name: 'spaceInset(deprecated)',
type: 'MQ<string>',
description: `Use paddingBlock and paddingInline instead. Apply space inset to the Block.`,
description: `Use paddingBlock and paddingInline instead. Apply spaceInset to the block`,
},
{
name: 'transitionPreset',
type: 'TransitionToken | TransitionToken[]',
default: 'backgroundColorChange',
description: `Apply transitionPreset to the Block component.`,
description: `Apply transitionPreset to the block`,
},
...(commonLogicalProps('propsRow') as PropsRowsProps[]),
],
propsFooter: (
<InlineMessage>
The Block can utilise any valid{' '}
The block can utilise any valid{' '}
<Link href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes">
HTML attribute.
</Link>
Expand Down