Skip to content

Commit edd3b1c

Browse files
authored
feat: update readme with tailwind 4 changes (#236)
1 parent cb7a2a2 commit edd3b1c

File tree

3 files changed

+73
-63
lines changed

3 files changed

+73
-63
lines changed

README.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -62,42 +62,47 @@ Click [here](https://github.com/qwikerx/flowbite-qwik/blob/main/packages/cli/REA
6262

6363
### 🐓 Manual way via `npm`
6464

65-
Make sure that you have <a href="https://nodejs.org/en/" rel="nofollow" >Node.js</a> and <a href="https://tailwindcss.com/" rel="nofollow" >Tailwind CSS</a> installed.
65+
Make sure that you have <a href="https://nodejs.org/en/" rel="nofollow" >Node.js</a> and <a href="https://tailwindcss.com/docs/installation" rel="nofollow" >Tailwind CSS</a> installed.
6666

67-
1. Install `flowbite` as a dependency using `npm` by running the following command:
67+
1. Install `flowbite-qwik` as a dependency using `npm` by running the following command:
6868

6969
```bash
70-
yarn add -D flowbite flowbite-qwik
71-
pnpm add -D flowbite flowbite-qwik
72-
npm i --save-dev flowbite flowbite-qwik
70+
yarn add -D flowbite flowbite-qwik flowbite-qwik-icons
71+
pnpm add -D flowbite flowbite-qwik flowbite-qwik-icons
72+
npm i --save-dev flowbite flowbite-qwik flowbite-qwik-icons
7373
```
7474

75-
2. Require `flowbite` as a plugin inside the `tailwind.config.js` file:
76-
77-
```javascript
78-
import flowbitePlugin from 'flowbite/plugin'
79-
80-
export default {
81-
theme: {
82-
extend: {
83-
animation: {
84-
'from-left': 'slideFromLeft 0.2s 1',
85-
'from-right': 'slideFromRight 0.2s 1',
86-
},
87-
keyframes: {
88-
slideFromLeft: {
89-
'0%': { transform: 'translateX(-100%)' },
90-
'100%': { transform: 'translateX(0)' },
91-
},
92-
slideFromRight: {
93-
'0%': { transform: 'translateX(100%)' },
94-
'100%': { transform: 'translateX(0)' },
95-
},
96-
},
97-
},
98-
},
99-
content: ['node_modules/flowbite-qwik/**/*.{cjs,mjs}', './src/**/*.{html,js,jsx,ts,tsx,mdx}'],
100-
plugins: [flowbitePlugin],
75+
2. Update you root CSS file (global.css) adding this configuration :
76+
77+
```css
78+
@plugin 'flowbite/plugin';
79+
80+
@source "../node_modules/flowbite-qwik";
81+
82+
@theme {
83+
--animate-from-left: slideFromLeft 0.2s 1;
84+
--animate-from-right: slideFromRight 0.2s 1;
85+
86+
--min-width-screen-lg: 1024px;
87+
88+
--container-8xl: 90rem;
89+
90+
@keyframes slideFromLeft {
91+
0% {
92+
transform: translateX(-100%);
93+
}
94+
100% {
95+
transform: translateX(0);
96+
}
97+
}
98+
@keyframes slideFromRight {
99+
0% {
100+
transform: translateX(100%);
101+
}
102+
100% {
103+
transform: translateX(0);
104+
}
105+
}
101106
}
102107
```
103108

apps/web/src/routes/docs/getting-started/quickstart/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export default component$(() => {
3232
<div>
3333
<Heading tag="h3">Install Flowbite Qwik</Heading>
3434
<p>Install Flowbite Qwik by running the following command in your project directory:</p>
35-
<CodeBlock language="bash" expandable={false} content="npm install flowbite-qwik flowbite-qwik-icons" />
35+
<CodeBlock language="bash" expandable={false} content="npm install flowbite flowbite-qwik flowbite-qwik-icons" />
3636
<p>
3737
Update you root CSS file (global.css) adding this configuration
3838
</p>

packages/lib/README.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -62,42 +62,47 @@ Click [here](https://github.com/qwikerx/flowbite-qwik/blob/main/packages/cli/REA
6262

6363
### 🐓 Manual way via `npm`
6464

65-
Make sure that you have <a href="https://nodejs.org/en/" rel="nofollow" >Node.js</a> and <a href="https://tailwindcss.com/" rel="nofollow" >Tailwind CSS</a> installed.
65+
Make sure that you have <a href="https://nodejs.org/en/" rel="nofollow" >Node.js</a> and <a href="https://tailwindcss.com/docs/installation" rel="nofollow" >Tailwind CSS</a> installed.
6666

67-
1. Install `flowbite` as a dependency using `npm` by running the following command:
67+
1. Install `flowbite-qwik` as a dependency using `npm` by running the following command:
6868

6969
```bash
70-
yarn add -D flowbite flowbite-qwik
71-
pnpm add -D flowbite flowbite-qwik
72-
npm i --save-dev flowbite flowbite-qwik
70+
yarn add -D flowbite flowbite-qwik flowbite-qwik-icons
71+
pnpm add -D flowbite flowbite-qwik flowbite-qwik-icons
72+
npm i --save-dev flowbite flowbite-qwik flowbite-qwik-icons
7373
```
7474

75-
2. Require `flowbite` as a plugin inside the `tailwind.config.js` file:
76-
77-
```javascript
78-
import flowbitePlugin from 'flowbite/plugin'
79-
80-
export default {
81-
theme: {
82-
extend: {
83-
animation: {
84-
'from-left': 'slideFromLeft 0.2s 1',
85-
'from-right': 'slideFromRight 0.2s 1',
86-
},
87-
keyframes: {
88-
slideFromLeft: {
89-
'0%': { transform: 'translateX(-100%)' },
90-
'100%': { transform: 'translateX(0)' },
91-
},
92-
slideFromRight: {
93-
'0%': { transform: 'translateX(100%)' },
94-
'100%': { transform: 'translateX(0)' },
95-
},
96-
},
97-
},
98-
},
99-
content: ['node_modules/flowbite-qwik/**/*.{cjs,mjs}', './src/**/*.{html,js,jsx,ts,tsx,mdx}'],
100-
plugins: [flowbitePlugin],
75+
2. Update you root CSS file (global.css) adding this configuration :
76+
77+
```css
78+
@plugin 'flowbite/plugin';
79+
80+
@source "../node_modules/flowbite-qwik";
81+
82+
@theme {
83+
--animate-from-left: slideFromLeft 0.2s 1;
84+
--animate-from-right: slideFromRight 0.2s 1;
85+
86+
--min-width-screen-lg: 1024px;
87+
88+
--container-8xl: 90rem;
89+
90+
@keyframes slideFromLeft {
91+
0% {
92+
transform: translateX(-100%);
93+
}
94+
100% {
95+
transform: translateX(0);
96+
}
97+
}
98+
@keyframes slideFromRight {
99+
0% {
100+
transform: translateX(100%);
101+
}
102+
100% {
103+
transform: translateX(0);
104+
}
105+
}
101106
}
102107
```
103108

0 commit comments

Comments
 (0)