Releases: chrisrzhou/react-wordcloud
v1.2.7
Overview
- Internal code cleanup (detypscriptify source code)
- Update docs, readme and other configs.
'Breaking' Changes: Tooltip CSS and Typings
Decoupled the tippy
CSS from the package. This will improve future versioning of the project, and is also the recommendation set by the tippy
project. Tooltips with this new versions might look off without CSS styles, but not considering this a breaking change because you can easily add the following imports to address the issue:
import 'tippy.js/dist/tippy.css';
import 'tippy.js/animations/scale.css'
Some rarely used typings are no longer exported (e.g. Enter
, Spiral
, WordToStringCallback
, WordEventCallback
, MinMaxPair
, AttributeValue
). While this is a breaking change, taking the liberty to assume this as non-breaking in an effort to constrain the exposed typings for improved future versioning of the project.
v1.2.6
- Correctly expose typings that were missing in
v1.2.5
. - Fix docs deploy by adding
.node-version
.
v1.2.5 [deprecated]
[deprecated]: This release is missing Typescript definitions. Avoid it if you depend on it.
v1.2.4
is a working build, but it accidentally shipped .docz
cache to the NPM registry... Fix this by explicitly setting files
in package.json
.
v.1.2.4 [deprecated]
[deprecated]: This release includes unnecessary
.doc
cache files in the build and is necessarily large.
- Added
...rest
props (@davidjb) - Added
tooltipOptions
tooptions
(@davidjb) to configuretippy
tooltips. - Added
svgAttributes
andtextAttributes
tooptions
to configure attributes onsvg
andtext
nodes. - Development: updated dependencies, XO lint rules, use absolute imports with
~
, spaces over tabs,microbundle
overrollup
,npm
overyarn
. - Updated docs
v.1.2.0
1.2.0 (2020-03-07)
This release is largely internal refactoring and updating dependencies, as well as 'de-typescripting' the codebase
API additions:
- Improve rendering performance for larger clouds and multiple cloud instances with the
options.enableOptimizations
flag.
Small Typescript breaking changes:
Spiral
andScale
enums are removed in favor of whitelisted string values. As part of moving to ambient declarations, these enums will not materialize in the compiled code.
Internal code changes:
- Update underlying dependencies via
yarn upgrade --latest
. Remove a ton of unneeded dependencies and correctly move@types/*
deps todevDependencies
. - Remove custom
eslint
,prettier
config and usexo
for a simpler linting setup. - Add
husky
pre-push hook. - Update and improve documentation with
[email protected]
. Improved various doc pages (Common Issues
) and added theOptimizations
andHome
page - Take the approach in various projects (e.g. three) to "de-typescript" the codebase and use
*.d.ts
files for typing in development. Continue to expose Typescript types to consumers.
v1.1.1
v1.1.0
1.1.0 (2019-09-08)
- Update dev configs + dependencies. Check with
yarn audit
. - Add documentation for
Options
andCallbacks
props. - Remove ignored Typescript errors, and fix typings in
render.ts
. - Simplify code in
hooks.ts
. - Simplify typed code.
- Expose
MouseEvent
object inonWordClick
,onWordMouseOut
andonWordMouseOver
callbacks
v1.0.7
Fix Typescript types
Emit typescript types for the module, so that various types can be used correctly in consumers.
v1.0.6
Support deterministic behavior + Improve dev tooling
- Support deterministic behavior for randomn layout and colors by configuring the
options.deterministic
field. This makes testing and creating fixed wordcloud views convenient. - Expose Typescript types.
- Use various
d3-*
packages instead of importingd3
entirely. - Update
docz
and docs. Add Codesandbox examples. - Move prettier rules from
.eslintrc.js
to.prettierrc.js
. This supports better formatting in MDX files with VSCode.
v1.0.5
Bug fixes and FAQ
New:
- Added
FAQ
page explaining common 'bugs', and updatedOptions
page with more examples - Handled recursive attempts to layout 'bad' clouds. Provide a console warning when max attempts have been made to layout 'bad' clouds.
- Changed default
minSize
andoptions.fontSizes
value to make things less buggy.
Bug fixes:
- Fixed a bug where
rotationAngles
was mutated.