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.

Sign up for GitHub

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(723): Standfirst Storybook Enhancement #881

Merged
merged 10 commits into from
May 16, 2023
Merged

docs(723): Standfirst Storybook Enhancement #881

Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5531254
docs(723): standfirst enhancements
May 8, 2023
c66132d
docs(723): refined theme and typograpghy presets
May 10, 2023
d0ee626
docs(723): removed themeing typograoghy
May 10, 2023
ab15409
docs(723): removed react fragements
May 10, 2023
05c44e9
docs(723): removed themeing
May 10, 2023
436140d
docs(723): removed themeing
May 11, 2023
bfe3ee8
docs(723): default story update
May 12, 2023
4fa8b37
docs(723): removed typograpghy
May 15, 2023
7f5e226
docs(723): removed typograpghy
May 15, 2023
4e093ab
docs(725): refinement
May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 101 additions & 79 deletions src/standfirst/__tests__/standfirst.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,105 +1,127 @@
import * as React from 'react';
import {Standfirst} from '..';
import {createTheme, ThemeProvider} from '../../theme';
import {StorybookSubHeading} from '../../test/storybook-comps';
import {ThemeProvider, CreateThemeArgs} from '../../theme';
import {Story as StoryType} from '@storybook/react';
import {createCustomThemeWithBaseThemeSwitch} from '../../test/theme-select-object';
import {StorybookCase, StorybookPage} from '../../test/storybook-comps';
import {TextBlock} from '../../text-block';
import {getColorCssFromTheme, styled} from '../../utils/style';

const myCustomTheme = createTheme({
name: 'my-custom-standfirst-theme',
overrides: {
stylePresets: {
standfirstCustom: {
base: {
color: '{{colors.blue060}}',
},
},
},
typographyPresets: {
standfirstCustom: {
fontFamily: '{{fonts.fontFamily1.fontFamily}}',
fontSize: '{{fonts.fontSize060}}',
lineHeight: '{{fonts.fontLineHeight030}}',
fontWeight: '{{fonts.fontWeight020}}',
letterSpacing: '{{fonts.fontLetterSpacing030}}',
},
},
},
});

const bodyString =
'Telling the stories that matter, seeding ideas and stirring emotion. Capturing moments, meaning and magic. Making sense of the world. On the shoulders of giants, in the thick of it, behind the scenes and fighting the good fight.';

export default {
title: 'Components/standfirst',
component: () => 'None',
};
const CONTENT = (
<TextBlock typographyPreset="utilitySubheading020">
NewsKit provides components, guidelines and standards to enable digital
product teams to create high-quality, consistent products quickly. NewsKit
is built on modular design principles and backed by best practice guidance
for design and development.
</TextBlock>
);
Copy link
Contributor

@mutebg mutebg May 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Why do you use text-block with typographyPreset to pass it down to the standfirst component?
Is that required by design? if so this needs to change, that's not how we suggest this component to be used

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mutebg as per design its typographyPreset="utilitySubheading020" by default we have

typographyPreset: {
        xs: 'editorialSubheadline010',
        lg: 'editorialSubheadline020',
},

So I have added text-block component to update the typographyPreset

Copy link
Contributor

Choose a reason for hiding this comment

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

the designs are wrong, the default version is without any props and overrides

Copy link
Contributor

Choose a reason for hiding this comment

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

@mutebg @jannuk59 The standfirst already has typography presets in the defaults, so there shouldn't be any need to add these to a content text block.

Copy link
Contributor

Choose a reason for hiding this comment

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

@nathanparris this exactly what I meant. thanks for clarifying it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done @mutebg @nathanparris. By default will be having

typographyPreset: {
        xs: 'editorialSubheadline010',
        lg: 'editorialSubheadline020',
},


export const StoryDefault = () => (
<>
<StorybookSubHeading>Standfirst - default</StorybookSubHeading>
<Standfirst>{bodyString}</Standfirst>
</>
<StorybookPage columns="1fr">
<StorybookCase>
<Standfirst as="h2">{CONTENT}</Standfirst>
Copy link
Contributor

Choose a reason for hiding this comment

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

since this is default story, I would remove as="h2" prop

</StorybookCase>
</StorybookPage>
);
StoryDefault.storyName = 'default';
StoryDefault.storyName = 'Default';

export const StoryWithAsProp = () => (
<>
<StorybookSubHeading>Standfirst - as h3</StorybookSubHeading>
<Standfirst as="h3">{bodyString}</Standfirst>
export const StoryWithAsSpan = () => (
<StorybookPage columns="1fr">
<StorybookCase>
<Standfirst as="span">{CONTENT}</Standfirst>
</StorybookCase>
</StorybookPage>
);
StoryWithAsSpan.storyName = 'Standfirst as span';

<StorybookSubHeading>Standfirst - as span</StorybookSubHeading>
<Standfirst as="span">{bodyString}</Standfirst>
</>
export const StoryLogicalProps = () => (
<StorybookPage columns="1fr">
<StorybookCase>
<MarginOverridesWrapper>
<Standfirst
overrides={{
styledText: {
paddingInline: '20px',
paddingBlock: '10px',
},
}}
>
{CONTENT}
</Standfirst>
</MarginOverridesWrapper>
</StorybookCase>
</StorybookPage>
);
StoryWithAsProp.storyName = 'with-as-prop';
StoryLogicalProps.storyName = 'Logical props';

export const StoryWithOverrides = () => (
<>
<ThemeProvider theme={myCustomTheme}>
<StorybookSubHeading>
Standfirst - with style-preset override
</StorybookSubHeading>
export const StoryWithStylingOverrides = () => (
<StorybookPage columns="1fr">
<StorybookCase>
<Standfirst
overrides={{
styledText: {
stylePreset: 'standfirstCustom',
stylePreset: 'inkBrand010',
},
}}
>
{bodyString}
{CONTENT}
</Standfirst>
<StorybookSubHeading>
Standfirst - with typography-preset override
</StorybookSubHeading>
</StorybookCase>
</StorybookPage>
);
StoryWithStylingOverrides.storyName = 'Styling overrides';

export const StoryWithOverrides = () => (
<StorybookPage columns="1fr">
<StorybookCase title="Typography preset override">
<Standfirst
as="span"
overrides={{
styledText: {
typographyPreset: 'editorialSubheadline020',
typographyPreset: 'utilitySubheading050',
},
}}
>
{bodyString}
NewsKit provides components, guidelines and standards to enable digital
product teams to create high-quality, consistent products quickly.
NewsKit is built on modular design principles and backed by best
practice guidance for design and development.
</Standfirst>
</ThemeProvider>
</>
</StorybookCase>
</StorybookPage>
);
StoryWithOverrides.storyName = 'with-overrides';
StoryWithOverrides.storyName = 'Overrides';

export const StoryLogicalProps = () => (
<>
<StorybookSubHeading>
Standfirst - logical padding props
</StorybookSubHeading>
<Standfirst
overrides={{styledText: {paddingInline: '20px', paddingBlock: '10px'}}}
>
{bodyString}
</Standfirst>
<StorybookSubHeading>Standfirst - logical margin props</StorybookSubHeading>
<Standfirst
overrides={{styledText: {marginInline: '20px', marginBlock: '10px'}}}
>
{bodyString}
</Standfirst>
</>
);
StoryLogicalProps.storyName = 'logical-props';
const MarginOverridesWrapper = styled.div`
border: 1px dashed;
${getColorCssFromTheme('borderColor', 'red060')}
`;

export default {
title: 'Components/Standfirst',
component: () => 'None',
parameters: {
nkDocs: {
title: 'Standfirst',
url: 'https://www.newskit.co.uk/components/standfirst/',
description:
'Standfirst is an introductory paragraph in an article, which summarises the articles content.',
},
},
decorators: [
(
Story: StoryType,
context: {name: string; globals: {backgrounds: {value: string}}},
) => (
<ThemeProvider
theme={createCustomThemeWithBaseThemeSwitch(
context?.globals?.backgrounds?.value,
{},
context?.name,
)}
>
<Story />
</ThemeProvider>
),
],
};