Skip to content

All basic components are ready. #4

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

Open
wants to merge 42 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
5f08570
feat✨: Completed contained button styling
agauravdev May 31, 2021
aadff05
feat✨: Completed styling of all buttons
agauravdev May 31, 2021
d5c603f
feat: ✨ Added input element
agauravdev Jun 3, 2021
677d437
feat: ✨ added alert and avatar components
agauravdev Jun 11, 2021
235e1e1
feat: ✨ added badges for icons and avatars
agauravdev Jun 12, 2021
3a2749b
chore: 🔧 fixed prettier warnings
agauravdev Jun 12, 2021
d350282
fix: 🐛 theme and badge fix
agauravdev Jun 12, 2021
a22b262
fix: 🐛 text button underline
agauravdev Jun 12, 2021
125db98
feat: ✨ added icon support to buttons
agauravdev Jun 12, 2021
fac64c6
chore: 🔧 minor button fixes
agauravdev Jun 12, 2021
14fbf85
chore: 🔧 fixed variant spelling xD
agauravdev Jun 15, 2021
c52c8e5
feat: ✨ added adornments to input and fixed styling
agauravdev Jun 17, 2021
6621bfd
feat: ✨ added helper text with error styling too in input
agauravdev Jun 17, 2021
2fc0585
feat: ✨ added lists component
agauravdev Jun 24, 2021
697232f
feat: ✨ added avatar to lists component for notification list
agauravdev Jun 25, 2021
2b732b4
feat: ✨ added modal component
agauravdev Jun 29, 2021
63b6695
feat: ✨ added close icon to modal
agauravdev Jun 30, 2021
b34b373
feat: ✨ added basic rating component
agauravdev Jul 2, 2021
98e6fd7
feat: ✨ updated rating component to improve accessibility (keyboard u…
agauravdev Jul 2, 2021
faba124
feat: ✨ updated rating component to clear value when clicked on the s…
agauravdev Jul 2, 2021
8d5e290
fix: 🐛 fixed outer div getting focused before the input element
agauravdev Jul 3, 2021
9455f37
feat: ✨ added simple grid component
agauravdev Jul 3, 2021
8867baf
feat: ✨ added typography component
agauravdev Jul 6, 2021
5426776
feat: ✨ added card component
agauravdev Jul 12, 2021
8aea5d9
feat: ✨ added responsive image component
agauravdev Jul 28, 2021
b27382e
feat: ✨ added basic navbar and minor bug fixes 🐛
agauravdev Aug 22, 2021
40e0ce0
fix: 🐛 fixed horizontal card component
agauravdev Aug 22, 2021
088e412
feat: ✨ added drawer component
agauravdev Aug 25, 2021
91730f2
feat: ✨ added snackbar component and fixed some bugs 🐛
agauravdev Aug 26, 2021
110aa0f
chore: 🔧 added default and global imports to all components and to th…
agauravdev Aug 27, 2021
3d67bdc
chore(release): 🚀 configured repo to make it a releasable package on npm
agauravdev Aug 28, 2021
6d29ec2
fix: 🐛 fixed button hovering when disabled and deleted some unused files
agauravdev Aug 28, 2021
0c559ba
test: 🚨 added storybook addon to test accessibility of the components
agauravdev Aug 28, 2021
ae1cf7e
fix: 🐛 fixed button click when disabled and added control to navsearch.
agauravdev Aug 28, 2021
874eafc
docs: 📚️ added instructions to run locally.
agauravdev Aug 29, 2021
83ab4df
fix: 🐛 fixed button when disabled
agauravdev Aug 29, 2021
0a582e4
fix: 🐛 fixed another button when disabled, lol
agauravdev Aug 29, 2021
04c962f
docs: 📚️ themed the storybook UI and added some docs
agauravdev Aug 29, 2021
a88f7ab
docs: 📚️ added theme provider specification in the doc
agauravdev Aug 29, 2021
033d223
fix: 🐛 fixed default import for ThemeProvider
agauravdev Aug 31, 2021
14440f8
feat: ✨ added styling and className prop to every component
agauravdev Aug 31, 2021
46a3403
feat: ✨ added children prop to required component
agauravdev Aug 31, 2021
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
7 changes: 7 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": ["react-app", "prettier"],
"plugins": ["prettier"],
"rules": {
"prettier/prettier": "warn"
}
}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

# production
/build
/lib
/storybook-static

# misc
.DS_Store
Expand Down
1 change: 1 addition & 0 deletions .husky/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_
4 changes: 4 additions & 0 deletions .husky/prepare-commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx devmoji -e --lint
5 changes: 5 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

84 changes: 84 additions & 0 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions .idea/codeStyles/codeStyleConfig.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/inspectionProfiles/Project_Default.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/matcha-ui.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions .idea/prettier.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"singleQuote": true,
"trailingComma": "es5",
"tabWidth": 4
}
22 changes: 22 additions & 0 deletions .storybook/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
module.exports = {
stories: [
'../src/**/*.stories.mdx',
'../src/**/*.stories.@(js|jsx|ts|tsx)',
],
addons: [
'@storybook/addon-links',
'@storybook/addon-essentials',
'@storybook/preset-create-react-app',
'@storybook/addon-a11y',
],
typescript: {
check: false,
checkOptions: {},
reactDocgen: 'none',
reactDocgenTypescriptOptions: {
shouldExtractLiteralValuesFromEnum: true,
propFilter: (prop) =>
prop.parent ? !/node_modules/.test(prop.parent.fileName) : true,
},
},
};
6 changes: 6 additions & 0 deletions .storybook/manager.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { addons } from '@storybook/addons';
import theme from './theme';

addons.setConfig({
theme: theme,
});
22 changes: 22 additions & 0 deletions .storybook/preview.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import React from 'react';
import ThemeProvider from '../src/components/ThemeProvider';
import { GlobalStyles } from '../src';

export const parameters = {
actions: { argTypesRegex: '^on[A-Z].*' },
controls: {
matchers: {
color: /(background|color)$/i,
date: /Date$/,
},
},
};

export const decorators = [
(Story) => (
<ThemeProvider>
<GlobalStyles />
<Story />
</ThemeProvider>
),
];
17 changes: 17 additions & 0 deletions .storybook/theme.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { create } from '@storybook/theming';

export default create({
colorPrimary: 'rgb(76, 175, 80)',
colorSecondary: 'rgb(255, 152, 0)',

// Typography
fontBase:
"-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif",

// Text colors
textColor: 'rgba(0, 0, 0, 0.87)',

base: 'light',
brandTitle: 'Matcha-UI',
brandImage: './logo.png',
});
31 changes: 31 additions & 0 deletions .vscode/React Forward Ref Component.code-snippets
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
// Place your matcha-ui workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
// Placeholders with the same ids are connected.
// Example:
"Print to console": {
"scope": "javascript,typescript",
"prefix": "log",
"body": ["console.log('$1');", "$2"],
"description": "Log output to console"
},
"React Forward Ref Component": {
"scope": "javascript, typescript, javascriptreact, typescriptreact",
"prefix": "rfrc",
"body": [
"import { ForwardRefRenderFunction } from 'react';",
"",
"",
"${3:PropsType} = {",
"$0",
"}",
"const ${1:Name}: ForwardRefRenderFunction<${2:RefType}, ${3:PropsType}> = (props, ref) => {",
"return <${4:StyledComponent} />",
"}",
"export default React.forwardRef<${2:RefType}, ${3:PropsType}>(${1:Name});"
]
}
}
15 changes: 15 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Chrome",
"type": "chrome",
"request": "launch",
"url": "http://localhost:3000",
"webRoot": "${workspaceFolder}/src",
"sourceMapPathOverrides": {
"webpack:///src/*": "${webRoot}/*"
}
}
]
}
4 changes: 4 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"editor.formatOnSave": true,
"prettier.useTabs": true
}
58 changes: 20 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,28 @@
# Getting Started with Create React App
<h2 align='center'> Matcha-UI</h2>
<p align='center'> Don't like writing CSS or just too lazy to write it? Don't worry, we've got you covered. Use our library and make beatiful React Apps without much CSS. :D </p>

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Installation

## Available Scripts
Matcha-UI is available as an [npm package](https://www.npmjs.com/package/@agauravdev/matcha-ui).

In the project directory, you can run:
```sh
// with npm
npm i @agauravdev/matcha-ui

### `yarn start`
// with yarn
yarn add @agauravdev/matcha-ui
```

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
To run this project locally till the time documentation gets ready, here's how.

The page will reload if you make edits.\
You will also see any lint errors in the console.
```sh
git clone https://github.com/gauravggg21/matcha-ui
cd matcha-ui
git checkout development

### `yarn test`
//with npm
npm run storybook

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `yarn eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).
//with yarn
yarn run storybook
```
Loading