Skip to content
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.

Sign up for GitHub

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

improve: allow adding class names to words #162

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

improve: allow adding class names to words #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ for more detailed props, please refer to below:
| padding | The padding accessor function, which indicates the numerical padding for each word. | `number \| (d) => number` | | `1` |
| random | The internal random number generator, used for selecting the initial position of each word, and the clockwise/counterclockwise direction of the spiral for each word. This should return a number in the range `[0, 1)`. | `(d) => number` | | `Math.random` |
| fill | The fill accessor function, which indicates the color for each word. | `(d, i) => string` | | `(d, i) => schemeCategory10ScaleOrdinal(i)` |
| wordClassNames | The classNames accessor function, which indicates the `class` for each word. | `(d, i) => string` | | `() => ''` |
| onWordClick | The function will be called when `click` event is triggered on a word | `(event, d) => {}` | | null |
| onWordMouseOver | The function will be called when `mouseover` event is triggered on a word | `(event, d) => {}` | | null |
| onWordMouseOut | The function will be called when `mouseout` event is triggered on a word | `(event, d) => {}` | | null |
Expand Down
3 changes: 3 additions & 0 deletions src/WordCloud.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ type WordCloudProps = {
padding?: number | ((word: Word, index: number) => number);
random?: () => number;
fill?: ValueFn<SVGTextElement, Word, string>;
wordClassNames?: ValueFn<SVGTextElement, Word, string>;
onWordClick?: (this: BaseType, event: any, d: Word) => void;
onWordMouseOver?: (this: BaseType, event: any, d: Word) => void;
onWordMouseOut?: (this: BaseType, event: any, d: Word) => void;
Expand All @@ -58,6 +59,7 @@ function WordCloud({
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore The ordinal function should accept number
fill = (_, i) => defaultScaleOrdinal(i),
wordClassNames = () => '',
onWordClick,
onWordMouseOver,
onWordMouseOut,
Expand Down Expand Up @@ -115,6 +117,7 @@ function WordCloud({
((d) => `${d.size}px`) as ValueFn<SVGTextElement, Word, string>
)
.style('fill', fill)
.attr('class', (d, i, nodes) => wordClassNames.call(nodes[i], d, i, nodes))
.attr('text-anchor', 'middle')
.attr('transform', (d) => `translate(${[d.x, d.y]})rotate(${d.rotate})`)
.text((d) => d.text);
Expand Down