Skip to content

Commit

Permalink
fix(customization in readme.md): added Customization section in readm…
Browse files Browse the repository at this point in the history
…e.md
  • Loading branch information
opensrc0 committed Feb 18, 2024
1 parent d10145b commit fe6a249
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 43 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ FE-Theme is a styled-component based comprehensive library of accessible, reusab
1. 🚀 [Features](#features)
2. 📦 [Installation](#installation)
3. 💻 [Usage](#usage)
4. ⚙️ [Customization](#customization)
4. 📚 [Online Editor Templates](#online-editor-templates)
5. 📝 [Contributing](#contributing)
6.[Contributors](#contributors)
Expand Down Expand Up @@ -91,9 +92,16 @@ import Button from 'fe-theme/Button';
```

  Wow, the configuration is quite simple, but wait... button design is different in your application.
  No worry, follow step 3, 4.
  No worry, Checkout Customization.

#### 3. Create your own theme

## Customization

#### 1. Create your own theme

==> You can generate config files for all the component automatically using command line [Check Commands](./.github/COMMAND.md).

==> You can also generate it Manually, follow steps given below.

   **a)** Create an empty folder called ```fe-theme-config``` in your application at any location.

Expand Down Expand Up @@ -134,9 +142,8 @@ export default {
};

```
Yeah, We have created config files Mannually but You can also generate config files automatically using command line [Check Commands](./.github/COMMAND.md)

#### 4. Pass the newly created theme file in init function
#### 2. Pass the newly created theme file in init function

```js
import { ThemeProvider } from 'styled-components';
Expand Down
10 changes: 5 additions & 5 deletions __appset/configFontFamily.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const FontFamily = {
"roboto": "Roboto",
"averta": "Averta",
"sans": "Open Sans,sans-serif"
}
roboto: 'Roboto',
averta: 'Averta',
sans: 'Open Sans,sans-serif',
};

export default FontFamily
export default FontFamily;
32 changes: 16 additions & 16 deletions __appset/configFontSize.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
const FontSize = {
"xxxxxl": "48px",
"xxxxl": "32px",
"xxxl": "28px",
"xxl": "24px",
"xl": "20px",
"l": "18px",
"m": "16px",
"md": "15px",
"s": "14px",
"sm": "13px",
"xs": "12px",
"xxs": "11px",
"xxxs": "10px",
"xxxxs": "8px"
}
xxxxxl: '48px',
xxxxl: '32px',
xxxl: '28px',
xxl: '24px',
xl: '20px',
l: '18px',
m: '16px',
md: '15px',
s: '14px',
sm: '13px',
xs: '12px',
xxs: '11px',
xxxs: '10px',
xxxxs: '8px',
};

export default FontSize
export default FontSize;
12 changes: 6 additions & 6 deletions __appset/configFontWeight.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
const FontWeight = {
"normal": "400",
"medium": "500",
"semibold": "600",
"bold": "700"
}
normal: '400',
medium: '500',
semibold: '600',
bold: '700',
};

export default FontWeight
export default FontWeight;
24 changes: 12 additions & 12 deletions __appset/configInput.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
const Input = {
"borderRadius": "4px",
"primary": {
"borderColor": "white"
borderRadius: '4px',
primary: {
borderColor: 'white',
},
"secondary": {
"borderColor": "white"
secondary: {
borderColor: 'white',
},
"tertiary": {
"borderColor": "white"
tertiary: {
borderColor: 'white',
},
"quaternary": {
"borderColor": "white"
}
}
quaternary: {
borderColor: 'white',
},
};

export default Input
export default Input;

0 comments on commit fe6a249

Please sign in to comment.