Skip to content
This repository has been archived by the owner on Oct 25, 2022. It is now read-only.

Commit

Permalink
Merge pull request #151 from eea/develop
Browse files Browse the repository at this point in the history
Upgrade to 3.x.x README update
  • Loading branch information
avoinea committed Sep 13, 2021
2 parents e9fac27 + 6cbca62 commit 71d8209
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 8 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@ All notable changes to this project will be documented in this file. Dates are d

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [3.0.1](https://github.com/eea/volto-slate/compare/3.0.0...3.0.1)

- Upgrade to 3.x.x [`e059861`](https://github.com/eea/volto-slate/commit/e0598619129614feddc9160011480eafa15d957c)

#### [3.0.0](https://github.com/eea/volto-slate/compare/3.0.0-alpha.0...3.0.0)

> 10 September 2021
- Release 3.0.0 [`#150`](https://github.com/eea/volto-slate/pull/150)
- Fix cypress api_url [`596cbfb`](https://github.com/eea/volto-slate/commit/596cbfbf1d1820c28faa1ea178ee05a2b6a72f9c)
- Add Sonarqube tag using ims-frontend addons list [`a97689d`](https://github.com/eea/volto-slate/commit/a97689de4dc39186da03ed0b1216471d2e305764)

Expand Down
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,20 @@ issues, the API starts to stabilize and we've already started several addons
based on it: https://github.com/eea/volto-slate-metadata-mentions/ and
https://github.com/eea/volto-slate-zotero

## Upgrades

### Upgrade to 3.x.x

* Removed all deprecated, already in Volto Core, `futurevolto` components:
* `SidebarPopup`
* `ObjectWidget`
* `ObjectBrowserWidget`
* `helpers/Blocks`
* Table `inline button` and `copy&paste` support is not installed by default anymore.
You'll need to explicitly import the `tableButton` profile like:
* `volto:asDefault,tableButton`
* `volto-slate:minimalDefault,simpleLink,tableButton`

## Why

Some of the main reasons that drove us to create volto-slate instead of
Expand All @@ -46,13 +60,13 @@ enhancing Volto's draftjs implementation:

volto-slate provides several optional configuration:

- `asDefault` which makes the volto-slate as the default richtext block editor
- `minimalDefault`, same as the above, but uses a set of toolbar buttons
similar to Volto
- `simpleLink` reuses Volto's link plugin and makes for a better replacement
of Volto's rich text editor.
- `tableButton` adds table button to Slate toolbar in order to easily insert
Table block after.
- `asDefault` - makes the volto-slate as the default Editor for `blocks` (and `richtext` widgets - not yet)
- `asDefaultBlock` - makes volto-slate the default Editor for `blocks`
- `asDefaultRichText` - makes volto-slate the default Editor for `richtext` widget (experimental)
- `minimalDefault`, same as the above, but uses a set of toolbar buttons similar to Volto
- `simpleLink` reuses Volto's link plugin and makes for a better replacement of Volto's rich text editor.
- `tableButton` adds table button to Slate toolbar in order to easily insert Table block after.


## Features

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "volto-slate",
"version": "3.0.0",
"version": "3.0.1",
"description": "Slate.js integration with Volto",
"main": "src/index.js",
"author": "European Environment Agency: IDM2 A-Team",
Expand Down

0 comments on commit 71d8209

Please sign in to comment.