You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# react-jqcloud
1
+
# react-jq-cloud
2
2
3
3
A React + TypeScript word cloud component based on the layout algorithm from [jQCloud](https://github.com/lucaong/jQCloud).
4
4
@@ -31,7 +31,7 @@ Words are placed on a spiral (elliptic or rectangular) starting from the center
31
31
## Installation
32
32
33
33
```bash
34
-
npm install react-jqcloud
34
+
npm install react-jq-cloud
35
35
```
36
36
37
37
Peer dependencies (`react` and `react-dom` ≥ 17) must already be installed in your project.
@@ -41,8 +41,8 @@ Peer dependencies (`react` and `react-dom` ≥ 17) must already be installed in
41
41
## Quick start
42
42
43
43
```tsx
44
-
import { WordCloud } from'react-jqcloud';
45
-
import'react-jqcloud/styles.css';
44
+
import { WordCloud } from'react-jq-cloud';
45
+
import'react-jq-cloud/styles.css';
46
46
47
47
const words = [
48
48
{ text: 'React', weight: 10 },
@@ -102,15 +102,15 @@ interface Word {
102
102
103
103
### CSS weight classes
104
104
105
-
When you import `react-jqcloud/styles.css` each word receives a class `w1`–`w10` (1 = lightest, 10 = heaviest). You can override these classes in your own stylesheet:
105
+
When you import `react-jq-cloud/styles.css` each word receives a class `w1`–`w10` (1 = lightest, 10 = heaviest). You can override these classes in your own stylesheet:
106
106
107
107
```css
108
108
/* your-styles.css */
109
-
.react-jqcloud.w10 { color: #e63946; }
110
-
.react-jqcloud.w9 { color: #e63946; }
111
-
.react-jqcloud.w8 { color: #457b9d; }
109
+
.react-jq-cloud.w10 { color: #e63946; }
110
+
.react-jq-cloud.w9 { color: #e63946; }
111
+
.react-jq-cloud.w8 { color: #457b9d; }
112
112
/* … */
113
-
.react-jqcloud.w1 { color: #a8dadc; }
113
+
.react-jq-cloud.w1 { color: #a8dadc; }
114
114
```
115
115
116
116
### Inline colors
@@ -277,8 +277,8 @@ Contributions are welcome — bug reports, feature requests, and pull requests a
0 commit comments