Skip to content

Commit 8b86d6f

Browse files
jrakibi0tuedon
andauthored
feat: add new-branding components (#47)
* feat: add Search component * add PropTypes validation and fix linter errors (#43) * add PropTypes validation and fix linter errors * run formatter * fix typo * Add Icons and tags (#44) * Add icons * Add tags * add accidentally deleted icons * run formatter for all files * add args to fix typecheck errors * Add pills (#45) * add pills * format code * feat: New Card for BDP (#46) * chore(new-components): new componens from branding * feat(card): bdp card addition * chore:initial commit * --amend --------- Co-authored-by: 0tuedon <90271995+0tuedon@users.noreply.github.com>
1 parent d3611f4 commit 8b86d6f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+8974
-2454
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ Make your changes and check that they resolve the problem with an example in Sto
2424

2525
You also need to inform Yarn workspaces that a particular package has changed for proper versioning. Run `yarn version check -i` to mark the appropriate type of change for those packages.
2626

27-
Lastly, run `yarn build` to ensure that the build runs successfully before submitting the pull request.
27+
Lastly, run `yarn build` to ensure that the build runs successfully before submitting the pull request.

.github/workflows/check-code.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,9 @@ jobs:
2222

2323
- name: Run lint
2424
run: yarn lint
25-
25+
2626
- name: Check formatting
2727
run: yarn format:check
2828

2929
- name: Run typecheck
3030
run: yarn typecheck
31-

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
assets/images

.storybook/main.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import type { StorybookConfig } from "@storybook/react-webpack5";
22

33
const config: StorybookConfig = {
4+
staticDirs: ['../src/assets/images'],
45
stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
56
addons: [
67
"@storybook/addon-webpack5-compiler-swc",

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ To install the BDP-UI library, you can use the following command:
99
```bash
1010
yarn add @bitcoin-dev-project/bdp-ui
1111
```
12-
or
12+
13+
or
14+
1315
```bash
1416
npm i @bitcoin-dev-project/bdp-ui
1517
```
@@ -19,10 +21,12 @@ npm i @bitcoin-dev-project/bdp-ui
1921
Once installed, you can import the components or icons you need from the library:
2022

2123
## CSS workaround
24+
2225
Kindly import the css file to your global entry point.
2326
Usually, that is `app/layout.tsx`
2427

2528
_note: import the css before your global css so if there are any conflicts your css takes precedence_
29+
2630
```tsx
2731
// app/layout.tsx
2832
...
@@ -33,6 +37,7 @@ import "./globals.css";
3337

3438
If you use tailwind for styling, also point your tailwind config to the library
3539
i.e
40+
3641
```tsx
3742
// tailwind.config.ts
3843
...
@@ -47,31 +52,29 @@ const config: Config = {
4752
```
4853
4954
### Components
55+
5056
Here is how you can import and use components
5157
5258
```jsx
53-
import { Button } from '@bitcoin-dev-project/bdp-ui';
59+
import { Button } from "@bitcoin-dev-project/bdp-ui";
5460

5561
function App() {
56-
return (
57-
<Button>Hello, World!</Button>
58-
);
62+
return <Button>Hello, World!</Button>;
5963
}
6064
```
6165
6266
### Icons
67+
6368
Here is how you can import icons
6469
6570
```jsx
66-
import { GithubIcon } from '@bitcoin-dev-project/bdp-ui/icons';
71+
import { GithubIcon } from "@bitcoin-dev-project/bdp-ui/icons";
6772

6873
function App() {
69-
return (
70-
<GithubIcon className="w-[40px] text-black" />
71-
);
74+
return <GithubIcon className="w-[40px] text-black" />;
7275
}
7376
```
7477
7578
## License
7679
77-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
80+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

0 commit comments

Comments
 (0)