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

Jump to bottom

fix: typo #32

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: typo #32

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b0b17f7
chore: fix typo
Shubhdeep12 Jul 17, 2022
b0d3e15
chore: fix typos
Shubhdeep12 Jul 17, 2022
76ff7d8
Merge branch 'main' into fix/typo
Jul 19, 2022
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
2 changes: 1 addition & 1 deletion .storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ addParameters({
order: [
'Introduction',
'Foundation',
['Colors', 'Typography', 'Layout', 'Miscellaneous', 'Customisation'],
['Colors', 'Typography', 'Layout', 'Miscellaneous', 'Customization'],
Copy link
Contributor

Choose a reason for hiding this comment

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

While both customise and customize both are valid. We need to have only one being used majorly across the documentation. There might be other words like analyse, analyze. Changing only for customise might be pretty bad in that case.

Copy link
Author

@Shubhdeep12 Shubhdeep12 Jul 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

@harish-sethuraman Checked for other typo as well, but there aren't any.
Since, Documentation is following American English and considering that customise should be replaced with customize.

'Components',
],
},
Expand Down
2 changes: 1 addition & 1 deletion src/components/Button/Button.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ There can be 3 different types of button.
</Button>
</Canvas>

There can be 2 different variants of `flat` and `elevated` kind buttton
There can be 2 different variants of `flat` and `elevated` kind button

<Canvas>
<Button variant="primary" kind="flat" size="big">
Expand Down
12 changes: 6 additions & 6 deletions src/components/Helpers/Customise.stories.mdx → src/components/Helpers/Customize.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { mainColors, colorPalette } from '@primitives';
import { hexToRGBA } from '@utils';
import { FontWeights, FontType } from '@types';

<Meta title="Foundation/Customisation" />
<Meta title="Foundation/Customization" />

export const colorConfig = {
backgroundColor: mainColors.black,
Expand All @@ -22,7 +22,7 @@ export const colorConfig = {
},
},
};
export const CustomiseButton = (args) => {
export const CustomizeButton = (args) => {
return (
<Button
size="big"
Expand All @@ -37,11 +37,11 @@ export const CustomiseButton = (args) => {
);
};

# How to Customise
# How to Customize

All neoPOP components use default neoPOP styles based on props passed to the components.
The styles like color and typography is decided based on the `colors` and `typography` mentioned in Foundation respectively.
To customise the component even further with your own theme, we provide 2 ways
To customize the component even further with your own theme, we provide 2 ways

1. Extend color primitives
2. Custom props
Expand Down Expand Up @@ -127,7 +127,7 @@ export default MyCustomButton;
```

<Canvas style={{ background: '#0d0d0d' }}>
<Story name="Custom ColorConfig Button">{CustomiseButton.bind()}</Story>
<Story name="Custom ColorConfig Button">{CustomizeButton.bind()}</Story>
</Canvas>

## Passing `textStyle` to the component
Expand Down Expand Up @@ -174,7 +174,7 @@ const MyCustomButton = () => {
},
}}
>
{CustomiseButton.bind()}
{CustomizeButton.bind()}
</Story>
</Canvas>

Expand Down