Skip to content

Commit

Permalink
Update documentation ready to release 3.1
Browse files Browse the repository at this point in the history
* Bump package version number
  • Loading branch information
MaybeJustJames committed Nov 5, 2024
1 parent 616134c commit ba1243d
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 6 deletions.
11 changes: 10 additions & 1 deletion ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [3.1.0] - 2024-11-05

### Changed

- The `atomStyle` and `atomLabelStyle` callbacks take an integer argument rather than a boolean
indicating whether they're selected or not. react-2d-molecule no longer tracks if an atom is
"selected".

## [3.0.2] - 2023-07-24

### Fixed
Expand Down Expand Up @@ -54,7 +62,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

Initial release

[unreleased]: https://github.com/vibbits/react-2d-molecule/compare/v3.0.2...HEAD
[unreleased]: https://github.com/vibbits/react-2d-molecule/compare/v3.1.0...HEAD
[3.1.0]: https://github.com/vibbits/react-2d-molecule/compare/v3.0.2...v3.1.0
[3.0.2]: https://github.com/vibbits/react-2d-molecule/compare/v3.0.1...v3.0.2
[3.0.1]: https://github.com/vibbits/react-2d-molecule/compare/v3.0.0...v3.0.1
[3.0.0]: https://github.com/vibbits/react-2d-molecule/compare/v2.0.0...v3.0.0
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ This is rendered as:
* `labelTranslateY: number` Translate each atom label, in the y direction, by this number of pixels (default: `0`).
* `atomClicked: (index: number) => void` A callback function accepting the index of the clicked atom.
* `atomLabel: (atom: Atom, index: number) => string` A callback function defining the text to display in the label for the given atom.
* `atomStyle: (element: string, selected: boolean): React.CSSProperties` A hook specifying CSS styles for the SVG `<circle>`.
* `atomLabelStyle: (element: string, selected: boolean): React.CSSProperties` A hook specifying CSS styles for the SVG `<text>`.
* `atomStyle: (element: string, index: number): React.CSSProperties` A hook specifying CSS styles for the SVG `<circle>`.
* `atomLabelStyle: (element: string, index: number): React.CSSProperties` A hook specifying CSS styles for the SVG `<text>`.

## Contributing

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@vibbioinfocore/react-2d-molecule",
"version": "3.0.2",
"version": "3.1.0",
"description": "A React component to display molecule structures in a 2D SVG",
"browser": "dist/index.js",
"main": "./dist/index.js",
Expand Down

0 comments on commit ba1243d

Please sign in to comment.