remirror v0.5.0 Release Notes

Release Date: 2019-09-23 // over 4 years ago
  • โž• Added

    • ๐Ÿ†• ๐Ÿš€ @remirror/react-hooks: New package for shared react hooks.
    • ๐Ÿ†• ๐Ÿš€ @remirror/react-portals: New package for the remirror / react portals.
    • ๐Ÿ†• ๐Ÿš€ @remirror/react-node-view: New package for prosemirror node views built with react components.
    • ๐Ÿ†• ๐Ÿš€ @remirror/dev: New package developing extensions and components.
    • ๐Ÿ†• ๐Ÿš€ prosemirror-suggest: New package for managing prosemirror suggestions.
    • ๐Ÿ†• ๐Ÿš€ test-keyboard: New package for dispatching keyboard events.
    • ๐Ÿ’ป ๐Ÿš€ @remirror/ui, @remirror/ui-buttons, @remirror/ui-dropdown, @remirror/ui-icons, @remirror/ui-menus, @remirror/ui-modal, @remirror/ui-text: New packages and several utilities for managing the ui of a remirror editor.
    • ๐Ÿš€ @remirror/core: Introduce the concept of meta tags for extensions. These allow an extension to tag itself and these tags are made available through the tag object which is passed to all extension methods.
    • ๐Ÿš€ @remirror/core: Add a helpers method to extensions. These are similar to commands except they don't have access to the view and shouldn't directly affect the editor. They can also return data and receive custom parameters. They can be accessed with manager.data.helpers.myHelper().
    • ๐Ÿš€ @remirror/core-extensions: Add TrailingNodeExtension to always append a specified node to the end of the dom.
    • @remirror/core: Add getExtraAttrs method to the extension which can be used in the (Mark/Node)Extension.
    • ๐Ÿš€ @remirror/core: Add DropCursorExtension for a cursor to show up at the exact location an item will be dropped.
    • ๐Ÿ‘ ๐Ÿš€ @remirror/core: Add GapCursorExtension for support of tricky to select locations.

    • 0๏ธโƒฃ Introduce new @builtin annotation to show when an extension is included by default.

    • Introduce new @schema annotation for extension options to indicated that an option should not be updated after creating or it will change the schema.

    • ๐Ÿ†• New command yarn generate:json which auto generates json files for support/rollup/rollup.config.js, support/storybook/.babelrc.js, support/tsconfig.paths.json and .size-limit.json. Previously these were maintained manually.

    ๐Ÿ”„ Changed

    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/react-renderer: Updated the name of @remirror/renderer-react for consistency.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/core: @emotion/core is now a peerDependency. When adding this library to your project you will need to yarn add @emotion/core as well. This is required to prevent bugs with version conflicts within the EmotionThemeProvider.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/core: deepMerge now takes multiple parameters instead of one array of objects to merge.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/core @remirror/core-extensions and all extensions: Refactor ExtensionTypes with a whole set of helpers for better type checking and self documenting types. Now the remirror component can receive the List of Extensions and from this infer the nodes, marks and actions available on any editor. Currently this inference has only been added to the Wysiwyg editor but will be added to the Twitter editor and all future editors.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/core @remirror/core-extensions: Move ParagraphExtension from core to core-extensions. The reason is to not pollute the core library with formatting methods which are primarily just for extensions.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/core: Rename ExtensionType.EXTENSION = 'extension' to ExtensionType.Plain = 'plain'.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/ui: Rename @remirror/react-components to @remirror/ui. It is now the base component that will be used for all ui related functionality.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/react-utils: Refactor the type signature of node views and improve their design. Now node view takes attrs and options.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/react: Rename NodeViewPortalComponent to RemirrorPortals since it now supports decorations.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/react: Change the name of useRemirror to useRemirrorContext.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/editor-social: Rename @remirror/editor-twitter to @remirror/editor-social for branding reasons.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/core: Rename NodeViewPortalContainer to PortalContainer.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/core: Refactor the type signature of SSRComponents to only take a node and options extraAttrs configuration to enable parsing the dom.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING jest-prosemirror: Names of matchers have been changed. transformsPMNode is now toTransformNode and toEqualPMNode is now toEqualProsemirrorNode.

    • โšก๏ธ @remirror/core: Update extraAttrs configuration to enable parsing the dom.

    • 0๏ธโƒฃ @remirror/core: Make default priority level for extensions 3 instead of 2. A lower number means the extension is deemed more important and ordered earlier in lists.

    • @remirror/core-extensions: Add extraAttrs to the following extensions: LinkExtension, ParagraphExtension, HeadingExtension.

    โœ‚ Removed

    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/renderer-react: Removed package.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/react-utils: Remove placeholder prop from the RemirrorManager.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/react: Remove higher order components.
    • ๐Ÿ’ฅ ๐Ÿ’ฅ BREAKING @remirror/react: Remove withoutEmotion prop. This should now be configured via the RemirrorThemeProvider component.