@plone/volto 16.0.0-alpha.14 → 16.0.0-alpha.15

package/locales/ro/LC_MESSAGES/volto.po

@@ -2606,7 +2606,8 @@ msgstr "Schimbă cu"
 msgid "Table"
 msgstr "Tabel"
 
-#: components/manage/Blocks/ToC/View
+#: components/manage/Blocks/ToC/variations/DefaultTocRenderer
+#: components/manage/Blocks/ToC/variations/HorizontalMenu
 # defaultMessage: Table of Contents
 msgid "Table of Contents"
 msgstr "Cuprins"

package/locales/volto.pot

@@ -2608,7 +2608,8 @@ msgstr ""
 msgid "Table"
 msgstr ""
 
-#: components/manage/Blocks/ToC/View
+#: components/manage/Blocks/ToC/variations/DefaultTocRenderer
+#: components/manage/Blocks/ToC/variations/HorizontalMenu
 # defaultMessage: Table of Contents
 msgid "Table of Contents"
 msgstr ""

package/package.json

@@ -9,7 +9,7 @@
     }
   ],
   "license": "MIT",
-  "version": "16.0.0-alpha.14",
+  "version": "16.0.0-alpha.15",
   "repository": {
     "type": "git",
     "url": "git@github.com:plone/volto.git"
@@ -81,6 +81,7 @@
     },
     "moduleNameMapper": {
       "@plone/volto/(.*)$": "<rootDir>/src/$1",
+      "@plone/volto-slate": "<rootDir>/packages/volto-slate/src",
       "~/config": "<rootDir>/src/config",
       "~/../locales/${lang}.json": "<rootDir>/locales/en.json",
       "(.*)/locales/(.*)": "<rootDir>/locales/$2",
@@ -289,6 +290,8 @@
     "http-proxy-middleware": "2.0.1",
     "husky": "4.2.5",
     "identity-obj-proxy": "3.0.0",
+    "image-extensions": "1.1.0",
+    "is-url": "1.2.4",
     "jest-css-modules": "1.1.0",
     "jest-environment-jsdom-sixteen": "1.0.3",
     "jest-file": "1.0.0",
@@ -335,6 +338,7 @@
     "react-dropzone": "11.1.0",
     "react-fast-compare": "2.0.4",
     "react-image-gallery": "1.2.7",
+    "react-intersection-observer": "9.1.0",
     "react-intl": "3.8.0",
     "react-intl-redux": "2.2.0",
     "react-medium-image-zoom": "3.0.15",
@@ -366,6 +370,10 @@
     "semantic-ui-react": "2.0.3",
     "semver": "5.6.0",
     "serialize-javascript": "3.1.0",
+    "slate": "0.78.0",
+    "slate-history": "0.66.0",
+    "slate-hyperscript": "0.77.0",
+    "slate-react": "0.78.1",
     "start-server-and-test": "1.14.0",
     "stylelint": "14.0.1",
     "stylelint-config-idiomatic-order": "8.1.0",

package/packages/README.md

@@ -0,0 +1,7 @@
+# Packages
+
+This directory is intended to contain packages related to Volto ecosystem.
+
+It was never intended to convert this repo in a monorepo.
+
+Main Volto package is still located in the root, and it's intended to continue doing so.

package/packages/volto-slate/.i18n.babel.config.js

@@ -0,0 +1 @@
+module.exports = require('../../babel');

package/packages/volto-slate/README.md

@@ -0,0 +1,235 @@
+# volto-slate
+
+TODO: fill in
+
+An alternative text editor for Volto, capable of completely replacing the
+default richtext editor while offering enhanced functionality and behavior. We
+believe that, in order to succeed, Volto's richtext form editor (the Volto
+Composite Page editor) needs strong integration between the rich text
+capabilities and the rest of the Volto blocks. Some examples of the kind of
+strong integration we have in mind:
+
+- Pasting complex documents inside a volto-slate text block will create
+  multiple Volto blocks: images will be converted to Volto Image blocks, tables
+  will be converted to Volto Table blocks, etc.
+- The text block accepts drag&drop images and it will upload them as Volto Image blocks.
+- volto-slate has a Table button with the familiar size input, but it create a Table block
+
+While this addon is still in an early alpha stage, we've solved most of the big
+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
+
+## Why
+
+Some of the main reasons that drove us to create volto-slate instead of
+enhancing Volto's draftjs implementation:
+
+- Volto's draftjs implementation depends on draft-js-plugins, a third-party
+  project that introduces its own set of bugs and maintanance issues
+- Slate has a modern, developer-friendly api that makes developing plugins
+  something easy to do. Getting the editor in a plugin is as easy as `const editor = useSlate()`, overriding core functionality is something that's built
+  in as pluggable, directly in Slate.
+
+- Volto's draft based implementation depends on Redraft for its final output,
+  which comes with its own bugs and issues. While it is nice to have view-mode
+  components, this is something that volto-slate implements just as well.
+- Because Slate's internal storage uses a tree modeled on the DOM pattern, its
+  final rendered output is very clean. Note: The Slate editor value is a JSON
+  object, similar to the Draftjs based implementation.
+
+## Upgrades
+
+### Upgrade to 4.x.x
+
+- Namespace the plugins [#156](https://github.com/eea/volto-slate/pull/156):
+  - Make sure you upgrade your slate plugins to use the new slate namespaced plugin ids.
+    See for example `volto-slate-footnote` [#23](https://github.com/eea/volto-slate-footnote/pull/23/commits/efdc07041097a6edf608b377141fba15fbee65cf)
+- `asDefault` profile makes the volto-slate as the default Editor for `blocks` and `richtext`.
+  - If you're not ready for this, yet, switch to `volto-slate:asDefaultBlock`
+
+### 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`
+
+## Available profiles.
+
+volto-slate provides several optional configuration:
+
+- `asDefault` - makes the volto-slate as the default Editor for `blocks` and `richtext`
+- `asDefaultBlock` - makes volto-slate the default Editor for `blocks`
+- `asDefaultRichText` - makes volto-slate the default Editor for `richtext` widget
+- `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
+
+#### 1. Hovering (floating) toolbar that shows up on selection
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/1.gif)
+
+#### 2. Optional expanded (fixed) toolbar
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/2.gif)
+
+#### 3. Working with links (internal, external, email)
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/3.gif)
+
+#### 4. Removing links
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/4.gif)
+
+#### 5. Editing links
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/5.gif)
+
+#### 6. Block-quotes
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/6.gif)
+
+#### 7. Split paragraph block in two with `Enter` key and join them back with `Backspace` key
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/7.gif)
+
+#### 8. Breaking and joining list items
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/8.gif)
+
+#### 9. Breaking (with expanded selection) and joining list items
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/9.gif)
+
+#### 10. Inserting a new list item at the end
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/10.gif)
+
+#### 11. Two `Enter` key presses in the last empty list item creates a new list
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/11.gif)
+
+#### 12. Using `Up` and `Down` keys to go through the blocks in both directions
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/12.gif)
+
+#### 13. Changing indent level of list items using `Tab` and `Shift-Tab` keys
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/13.gif)
+
+#### 14. Splitting a list block with `Enter` into two list blocks
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/14.gif)
+
+#### 15. Support for markdown bulleted lists with `*`, `-` and `+`
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/15.gif)
+
+#### 16. Support for markdown numbered lists with `1.` - `9.`
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/16.gif)
+
+#### 17. `Backspace` with cursor on first position inside a list with just one item converts the list to a paragraph
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/17.gif)
+
+#### 18. Creating a new text block with `Enter` at the end of a text block and removing it with `Backspace`
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/18.gif)
+
+#### 19. Switching the list type (numbered list to/from bulleted list)
+
+![Screen Recording](https://raw.githubusercontent.com/eea/volto-slate/master/docs/source/images/19.gif)
+
+## Getting started
+
+### Try volto-slate with Docker
+
+1. Get the latest Docker images
+
+   ```
+   docker pull plone
+   docker pull plone/volto
+   ```
+
+1. Start Plone backend
+
+   ```
+   docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
+   ```
+
+1. Start Volto frontend
+
+   ```
+   docker run -it --rm -p 3000:3000 --link plone -e ADDONS="volto-slate:asDefault" plone/volto
+   ```
+
+1. Go to http://localhost:3000
+
+1. Login with **admin:admin**
+
+1. Create a new **Page** and add a new **Text** block.
+
+### Add volto-slate to your Volto project
+
+1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
+
+1. Start Volto frontend
+
+- If you already have a Volto project, just update `package.json`:
+
+  ```JSON
+  "addons": [
+      "volto-slate:asDefault"
+  ],
+
+  "dependencies": {
+      "volto-slate": "*"
+  }
+  ```
+
+- If not, create one:
+
+  ```
+  npm install -g yo @plone/generator-volto
+  yo @plone/volto my-volto-project --addon volto-slate:asDefault
+  cd my-volto-project
+  ```
+
+- Install new add-ons and restart Volto:
+
+  ```
+  yarn install
+  yarn start
+  ```
+
+1. Go to http://localhost:3000
+
+1. Happy editing!
+
+## Plugins
+
+To write a new plugin, please refer [plugins](https://github.com/eea/volto-slate/tree/master/docs/source/volto-slate-plugins.md)
+
+## Cypress
+
+We aim to achieve a good coverage for cypress. Please refer to commands listed [here](https://github.com/eea/volto-slate/tree/master/docs/source/testing.md) to ease the process of writing new tests.
+
+## Copyright and license
+
+The Initial Owner of the Original Code is European Environment Agency (EEA).
+All Rights Reserved.
+
+See [LICENSE.md](https://github.com/eea/volto-slate/blob/master/LICENSE.md) for details.
+
+## Funding
+
+[European Environment Agency (EU)](http://eea.europa.eu)

package/packages/volto-slate/build/messages/src/blocks/Table/TableBlockEdit.json

@@ -0,0 +1,90 @@
+[
+  {
+    "id": "Insert row before",
+    "defaultMessage": "Insert row before"
+  },
+  {
+    "id": "Insert row after",
+    "defaultMessage": "Insert row after"
+  },
+  {
+    "id": "Delete row",
+    "defaultMessage": "Delete row"
+  },
+  {
+    "id": "Insert col before",
+    "defaultMessage": "Insert col before"
+  },
+  {
+    "id": "Insert col after",
+    "defaultMessage": "Insert col after"
+  },
+  {
+    "id": "Delete col",
+    "defaultMessage": "Delete col"
+  },
+  {
+    "id": "Hide headers",
+    "defaultMessage": "Hide headers"
+  },
+  {
+    "id": "Make the table sortable",
+    "defaultMessage": "Make the table sortable"
+  },
+  {
+    "id": "Visible only in view mode",
+    "defaultMessage": "Visible only in view mode"
+  },
+  {
+    "id": "Fixed width table cells",
+    "defaultMessage": "Fixed width table cells"
+  },
+  {
+    "id": "Make the table compact",
+    "defaultMessage": "Make the table compact"
+  },
+  {
+    "id": "Reduce complexity",
+    "defaultMessage": "Reduce complexity"
+  },
+  {
+    "id": "Divide each row into separate cells",
+    "defaultMessage": "Divide each row into separate cells"
+  },
+  {
+    "id": "Table color inverted",
+    "defaultMessage": "Table color inverted"
+  },
+  {
+    "id": "Stripe alternate rows with color",
+    "defaultMessage": "Stripe alternate rows with color"
+  },
+  {
+    "id": "Left",
+    "defaultMessage": "Left"
+  },
+  {
+    "id": "Center",
+    "defaultMessage": "Center"
+  },
+  {
+    "id": "Right",
+    "defaultMessage": "Right"
+  },
+  {
+    "id": "Bottom",
+    "defaultMessage": "Bottom"
+  },
+  {
+    "id": "Middle",
+    "defaultMessage": "Middle"
+  },
+  {
+    "id": "Top",
+    "defaultMessage": "Top"
+  },
+  {
+    "id": "Table",
+    "defaultMessage": "Table"
+  }
+]

package/packages/volto-slate/build/messages/src/blocks/Text/DefaultTextBlockEditor.json

@@ -0,0 +1,6 @@
+[
+  {
+    "id": "Type text…",
+    "defaultMessage": "Type text…"
+  }
+]

package/packages/volto-slate/build/messages/src/blocks/Text/DetachedTextBlockEditor.json

@@ -0,0 +1,6 @@
+[
+  {
+    "id": "Type text…",
+    "defaultMessage": "Type text…"
+  }
+]

package/packages/volto-slate/build/messages/src/blocks/Text/SlashMenu.json

@@ -0,0 +1,6 @@
+[
+  {
+    "id": "No matching blocks",
+    "defaultMessage": "No matching blocks"
+  }
+]

package/packages/volto-slate/build/messages/src/editor/plugins/AdvancedLink/index.json

@@ -0,0 +1,10 @@
+[
+  {
+    "id": "Edit link",
+    "defaultMessage": "Edit link"
+  },
+  {
+    "id": "Remove link",
+    "defaultMessage": "Remove link"
+  }
+]

package/packages/volto-slate/build/messages/src/editor/plugins/Link/index.json

@@ -0,0 +1,10 @@
+[
+  {
+    "id": "Add link",
+    "defaultMessage": "Add link"
+  },
+  {
+    "id": "Edit link",
+    "defaultMessage": "Edit link"
+  }
+]

package/packages/volto-slate/build/messages/src/editor/plugins/Table/index.json

@@ -0,0 +1,30 @@
+[
+  {
+    "id": "Delete table",
+    "defaultMessage": "Delete table"
+  },
+  {
+    "id": "Insert row before",
+    "defaultMessage": "Insert row before"
+  },
+  {
+    "id": "Insert row after",
+    "defaultMessage": "Insert row after"
+  },
+  {
+    "id": "Delete row",
+    "defaultMessage": "Delete row"
+  },
+  {
+    "id": "Insert col before",
+    "defaultMessage": "Insert col before"
+  },
+  {
+    "id": "Insert col after",
+    "defaultMessage": "Insert col after"
+  },
+  {
+    "id": "Delete col",
+    "defaultMessage": "Delete col"
+  }
+]

package/packages/volto-slate/build/messages/src/elementEditor/messages.json

@@ -0,0 +1,10 @@
+[
+  {
+    "id": "Edit element",
+    "defaultMessage": "Edit element"
+  },
+  {
+    "id": "Remove element",
+    "defaultMessage": "Remove element"
+  }
+]

package/packages/volto-slate/build/messages/src/widgets/HtmlSlateWidget.json

@@ -0,0 +1,6 @@
+[
+  {
+    "id": "An error has occurred while editing \"{name}\" field. We have been notified and we are looking into it. Please save your work and retry. If the issue persists please contact the site administrator.",
+    "defaultMessage": "An error has occurred while editing \"{name}\" field. We have been notified and we are looking into it. Please save your work and retry. If the issue persists please contact the site administrator."
+  }
+]

package/packages/volto-slate/build/messages/src/widgets/RichTextWidgetView.json

@@ -0,0 +1,6 @@
+[
+  {
+    "id": "An error has occurred while rendering \"{name}\" field. We have been notified and we are looking into it. If the issue persists please contact the site administrator.",
+    "defaultMessage": "An error has occurred while rendering \"{name}\" field. We have been notified and we are looking into it. If the issue persists please contact the site administrator."
+  }
+]

package/packages/volto-slate/locales/de/LC_MESSAGES/volto.po

@@ -0,0 +1,148 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#: editor/plugins/Link/index
+msgid "Add link"
+msgstr "Link hinzufügen"
+
+#: widgets/HtmlSlateWidget
+msgid "An error has occurred while editing "{name}" field. We have been notified and we are looking into it. Please save your work and retry. If the issue persists please contact the site administrator."
+msgstr ""
+
+#: widgets/RichTextWidgetView
+msgid "An error has occurred while rendering "{name}" field. We have been notified and we are looking into it. If the issue persists please contact the site administrator."
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+msgid "Bottom"
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+msgid "Center"
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+#: editor/plugins/Table/index
+msgid "Delete col"
+msgstr "Spalte löschen"
+
+#: blocks/Table/TableBlockEdit
+#: editor/plugins/Table/index
+msgid "Delete row"
+msgstr "Zeile löschen"
+
+#: editor/plugins/Table/index
+msgid "Delete table"
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+msgid "Divide each row into separate cells"
+msgstr "Jede Zeile in einzelne Zellen teilen"
+
+#: elementEditor/messages
+msgid "Edit element"
+msgstr "Element bearbeiten"
+
+#: editor/plugins/AdvancedLink/index
+#: editor/plugins/Link/index
+msgid "Edit link"
+msgstr "Link bearbeiten"
+
+#: blocks/Table/TableBlockEdit
+msgid "Fixed width table cells"
+msgstr "Zellen mit fester Breite"
+
+#: blocks/Table/TableBlockEdit
+msgid "Hide headers"
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+#: editor/plugins/Table/index
+msgid "Insert col after"
+msgstr "Spalte dahinter einfügen"
+
+#: blocks/Table/TableBlockEdit
+#: editor/plugins/Table/index
+msgid "Insert col before"
+msgstr "Spalte davor einfügen"
+
+#: blocks/Table/TableBlockEdit
+#: editor/plugins/Table/index
+msgid "Insert row after"
+msgstr "Zeile dahinter einfügen"
+
+#: blocks/Table/TableBlockEdit
+#: editor/plugins/Table/index
+msgid "Insert row before"
+msgstr "Zeile davor einfügen"
+
+#: blocks/Table/TableBlockEdit
+msgid "Left"
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+msgid "Make the table compact"
+msgstr "Tabelle komprimieren"
+
+#: blocks/Table/TableBlockEdit
+msgid "Make the table sortable"
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+msgid "Middle"
+msgstr ""
+
+#: blocks/Text/SlashMenu
+msgid "No matching blocks"
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+msgid "Reduce complexity"
+msgstr "Komplexität vereinfachen"
+
+#: elementEditor/messages
+msgid "Remove element"
+msgstr "Element entfernen"
+
+#: editor/plugins/AdvancedLink/index
+msgid "Remove link"
+msgstr "Link entferenen"
+
+#: blocks/Table/TableBlockEdit
+msgid "Right"
+msgstr ""
+
+#: blocks/Table/TableBlockEdit
+msgid "Stripe alternate rows with color"
+msgstr "Zeilen im Wechsel einfärben"
+
+#: blocks/Table/TableBlockEdit
+msgid "Table"
+msgstr "Tabelle"
+
+#: blocks/Table/TableBlockEdit
+msgid "Table color inverted"
+msgstr "Tabellenfarbe invertiert"
+
+#: blocks/Table/TableBlockEdit
+msgid "Top"
+msgstr ""
+
+#: blocks/Text/DefaultTextBlockEditor
+#: blocks/Text/DetachedTextBlockEditor
+msgid "Type text…"
+msgstr "Text eingeben"
+
+#: blocks/Table/TableBlockEdit
+msgid "Visible only in view mode"
+msgstr ""