Skip to content

Commit

Permalink
chore(*): resolve merge conflict
Browse files Browse the repository at this point in the history
  • Loading branch information
clukhei committed Jan 5, 2024
2 parents 6f0941a + eedc9e6 commit 77f5afc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
14 changes: 11 additions & 3 deletions lib/sgds-x-family/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@

## Installation

`@govtechsg/sgds-x-family` is not shipped with any included CSS. Apply `@govtechsg/sgds@latest` styles by installing the module or using CDN.

Install the `@govtechsg/sgds-x-family` package via npm:

```sh
npm install @govtechsg/sgds-x-family
$ npm i @govtechsg/sgds-x-family @govtechsg/sgds
```

## Usage
Expand All @@ -16,7 +18,13 @@ npm install @govtechsg/sgds-x-family

To integrate `@govtechsg/sgds-x-family` styles into your React application with `react-select` components, follow these steps:

1. Import the `Select` component from `react-select` along with the required styles:
1. `@govtechsg/sgds-x-family/react-select` uses `bootstrap-icons` but does not ship with it. Install `bootstrap-icons` or use CDN.

```sh
$ npm i bootstrap-icons
```

2. Import the `Select` component from `react-select` along with the required styles:

```js
import Select, { components } from 'react-select';
Expand All @@ -25,7 +33,7 @@ import '@govtechsg/sgds-x-family/react-select/index.css';
import 'bootstrap-icons/font/bootstrap-icons.css';
```

2. Utilize the provided Select component within your application, ensuring the use of specific class names for SGDS styles:
3. Utilize the provided Select component within your application, ensuring the use of specific class names for SGDS styles:

```js
const OPTIONS = [
Expand Down
4 changes: 1 addition & 3 deletions lib/sgds-x-family/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,7 @@
"rollup": "^4.5.2",
"rollup-plugin-scss": "^4.0.0",
"sass": "^1.69.5",
"vite": "^5.0.5"
},
"peerDependencies": {
"vite": "^5.0.5",
"@govtechsg/sgds": "^2.1.1",
"bootstrap-icons": "^1.11.2",
"react-select": "^5.4.0"
Expand Down

0 comments on commit 77f5afc

Please sign in to comment.