diff --git a/scorelab.github.io b/scorelab.github.io new file mode 160000 index 00000000..7b535e95 --- /dev/null +++ b/scorelab.github.io @@ -0,0 +1 @@ +Subproject commit 7b535e95c7eae870b76e71cbbac8e0743e5cbd33 diff --git a/src/components/AnimatedLogin/AnimatedLogin.md b/src/components/AnimatedLogin/AnimatedLogin.md index 47b0acf5..c6f60f07 100644 --- a/src/components/AnimatedLogin/AnimatedLogin.md +++ b/src/components/AnimatedLogin/AnimatedLogin.md @@ -11,16 +11,17 @@ This is a reusable component for the Login page with animated background and typ Import the component to `pages/index.js` `import AnimatedLogin from "../components/AnimatedLogin";` + ## How to handle props to the component -``` - {}} /> -``` + `name` props is the name of organization `typeWriteWords` prop is the word list for typewriter diff --git a/src/components/BarChart/BarChart.md b/src/components/BarChart/BarChart.md index b84f05c8..925c573d 100644 --- a/src/components/BarChart/BarChart.md +++ b/src/components/BarChart/BarChart.md @@ -13,8 +13,9 @@ Import the component to `pages/index.js` ## How to handle props to the component -``` - -``` + ]} + title="Marks" + data={[40, 20, 12, 39, 10, 40, 39, 80, 40, 10, 91, 12, 15, 11]} + labelsName="months" + color="#f87979" +/> + `labels` prop is the labels of x axis of the bar chart `title` prop is title of the chart diff --git a/src/components/Breadcrumbs/Breadcrumbs.md b/src/components/Breadcrumbs/Breadcrumbs.md index 210e9c99..37700c39 100644 --- a/src/components/Breadcrumbs/Breadcrumbs.md +++ b/src/components/Breadcrumbs/Breadcrumbs.md @@ -13,8 +13,13 @@ Import the component to `pages/index.js` ## How to handle props to the component -``` - -``` +```jsx + + `elementList` prop is the list of navigation options. items in the list following this signature diff --git a/src/components/CardThemeFour/CardThemeFour.md b/src/components/CardThemeFour/CardThemeFour.md index cd66dc3c..5bf829d3 100644 --- a/src/components/CardThemeFour/CardThemeFour.md +++ b/src/components/CardThemeFour/CardThemeFour.md @@ -11,11 +11,15 @@ This is a resuasble component for the feature and services built from scratch. I Import the component to `pages/index.js` `import {CardThemeFour} from "../components/CardThemeFour";` + ## How to handle props to the component -``` - -``` +```jsx + `image` prop is used to display the main image of the card `title` prop is used to add the title to the card/feature diff --git a/src/components/CardThemeFourGrid/CardThemeFourGrid.md b/src/components/CardThemeFourGrid/CardThemeFourGrid.md index 85408444..ab226d91 100644 --- a/src/components/CardThemeFourGrid/CardThemeFourGrid.md +++ b/src/components/CardThemeFourGrid/CardThemeFourGrid.md @@ -11,12 +11,28 @@ This is a resuasble component for the card and services built from scratch in a Import the component to `pages/index.js` `import {CardThemeFourGrid} from "../components/CardThemeFourGrid";` + ## How to handle props to the component -``` - -``` +```jsx + + `image` props is the backgournd image of the section `dataUpperGrid` prop is the data of the upper gird diff --git a/src/components/CartTile/CartTile.md b/src/components/CartTile/CartTile.md index b6f99065..921994dd 100644 --- a/src/components/CartTile/CartTile.md +++ b/src/components/CartTile/CartTile.md @@ -13,14 +13,21 @@ Import the component to `pages/index.js` ## How to handle props to the component -``` - -``` - -`image` prop is the url of product -`name` prop is the name of product -`price` prop is the price of product -`qty` prop is the Number of items per product -`subtractionHandler` prop is the function for subtration icon -`additionHandler` prop is the function for subtration icon -`removeHandler` prop is the function for delete items +```jsx + {}} + additionHandler={() => {}} + removeHandler={() => {}} +/> + +image prop is the URL of the product +name prop is the name of the product +price prop is the price of the product +qty prop is the number of items per product +subtractionHandler prop is the function triggered on minus icon click +additionHandler prop is the function triggered on plus icon click +removeHandler prop is the function triggered on delete icon click diff --git a/src/components/DetailCard/DetailCard.md b/src/components/DetailCard/DetailCard.md index 2666627f..570a062f 100644 --- a/src/components/DetailCard/DetailCard.md +++ b/src/components/DetailCard/DetailCard.md @@ -13,9 +13,14 @@ Import the component to `pages/index.js` ## How to handle props to the component -``` - -``` +## How to handle props to the component + +```jsx + + `title` prop is used to add the title to the card/feature diff --git a/src/components/DetailCardGrid/DetailCardGrid.md b/src/components/DetailCardGrid/DetailCardGrid.md index 98d99aaa..95d68996 100644 --- a/src/components/DetailCardGrid/DetailCardGrid.md +++ b/src/components/DetailCardGrid/DetailCardGrid.md @@ -11,10 +11,19 @@ This is a resuasble component that contain three services cards arrange in a par Import the component to `pages/index.js` `import {DetailCardGrid} from "../components/DetailCardGrid";` + ## How to handle props to the component -``` - -``` +```jsx + + `gridHeading` prop is use to add the heading for the cards grid `data` prop is use to add the data for the cards \ No newline at end of file diff --git a/src/components/DocsBanner/DocsBanner.md b/src/components/DocsBanner/DocsBanner.md index f019c290..4102f35a 100644 --- a/src/components/DocsBanner/DocsBanner.md +++ b/src/components/DocsBanner/DocsBanner.md @@ -13,11 +13,14 @@ Import the component to `pages/index.js` ## How to handle props to the component -``` - -``` +```jsx + + `mainText` prop is the main title or heading for the banner `subText` prop is the subtext or side text for the banner diff --git a/src/components/DynamicBanner/DynamicBanner.md b/src/components/DynamicBanner/DynamicBanner.md index 61bd72ef..cfeae40b 100644 --- a/src/components/DynamicBanner/DynamicBanner.md +++ b/src/components/DynamicBanner/DynamicBanner.md @@ -13,14 +13,26 @@ Import the component to `pages/index.js` ## How to handle props to the component -``` - -``` +```jsx + + `mainText` prop is the main title or heading for the banner `subText` prop is the subtext or side text for the banner diff --git a/src/components/FeatureCard/FeatureCard.md b/src/components/FeatureCard/FeatureCard.md index f97c43a1..5ff9aadb 100644 --- a/src/components/FeatureCard/FeatureCard.md +++ b/src/components/FeatureCard/FeatureCard.md @@ -11,11 +11,16 @@ This is a resuasble component for the feature and services built from scratch. I Import the component to `pages/index.js` `import {FeatureCard} from "../components/FeatureCard";` + ## How to handle props to the component -``` - -``` +```jsx + + `image` prop is used to display the main image of the card `title` prop is used to add the title to the card/feature diff --git a/src/components/FooterLarge/FooterLarge.md b/src/components/FooterLarge/FooterLarge.md index bcbffc10..0fb51089 100644 --- a/src/components/FooterLarge/FooterLarge.md +++ b/src/components/FooterLarge/FooterLarge.md @@ -11,21 +11,35 @@ This is a reusable component for the footer of a website. This Component is high Import the component to `pages/index.js` `import {FooterLarge} from "../components/FooterLarge";` +## How to handle props to the component ## How to handle props to the component -``` +```jsx -``` + `headingOne` this prop is use to add the heading of the first section `headingTwo` this prop is use to add the heading of the second section diff --git a/src/components/FooterThemeFive/FooterThemeFive.md b/src/components/FooterThemeFive/FooterThemeFive.md index 73520069..a9f52185 100644 --- a/src/components/FooterThemeFive/FooterThemeFive.md +++ b/src/components/FooterThemeFive/FooterThemeFive.md @@ -13,20 +13,31 @@ Import the component to `pages/index.js` ## How to handle props to the component -``` +```jsx -``` + `headingOne` this prop is use to add the heading of the first section `headingTwo` this prop is use to add the heading of the second section