Skip to content

Commit

Permalink
docs: update changelog
Browse files Browse the repository at this point in the history
Fix typos
  • Loading branch information
ifiokjr committed Jul 6, 2019
1 parent 9876baf commit dea58ee
Showing 1 changed file with 31 additions and 25 deletions.
56 changes: 31 additions & 25 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,61 +7,67 @@ and this project will adhere to [Semantic Versioning](https://semver.org/spec/v2

## [Unreleased]

### Added

- πŸš€ `@remirror/extension-collaboration`: Collaboration library added based on the brilliant example available in [tiptap](https://github.com/scrumpy/tiptap).
- `@remirror/core`: Add `CommandNodeTypeParams`, `CommandMarkTypeParams`, `CommandTypeParams` which is now passed to the `commands` method for extensions.

### Changes

- πŸ’₯ **BREAKING `@remirror/core`:** Rename `getEditorState` to `getState`.
- πŸ’₯ **BREAKING `@remirror/core`:** Rename `getPortalContainer` to `getPortals`.

- πŸ› `@remirror/core`: Fix bug with extension manager failing to provide attributes from the extensions.
- πŸ› `@remirror/core`: Fix TypeScript type of SSRComponent. Change from `Component` to `ComponentType`.
- πŸ› `@remirror/editor-twitter`: Fix bug where text area didn't expand to full height of editor container.

## [0.3.0] - 2019-07-06

### Added

- πŸš€ `@remirror/extension-collaboration`: Collaboration library added based on the brilliant example available in [tiptap](https://github.com/scrumpy/tiptap).
- `@remirror/react`: Add `withoutEmotion` which, when set to `true`, removes emotion (css-in-js) from the `Remirror` component. This is for those who don't like css-in-js and would like to work directly with the raw editor without random styles injected. Consuming the `@remirror/react-components` or any of the `@remirror/editor-*` packages will require the use of emotion.
- `@remirror/react-utils`: Add `oneChildOnly` export which throws readable errors for invalid children props.
- `@remirror/core`: Add `CommandNodeTypeParams`, `CommandMarkTypeParams`, `CommandTypeParams` which is now passed to the `commands` method for extensions

### Changed

- πŸ’₯ **BREAKING `remirror/react-utils`:** Rename `childIsFunction` to `propIsFunction` and make it a _pseudo_ predicate function (returns true when it doesn't throw an error).
- πŸ’₯ **BREAKING `remirror/react`:** Rename `setChildAsRoot` to `childAsRoot` on `RemirrorContextProviderProps` and all it consumers. This affects the `RemirrorContextProvider`, `RemirrorProvider` and `ManagedRemirrorProvider` exports. The prop now can take a boolean or the object with props to inject into the root.
- πŸ’₯ **BREAKING `remirror/editor-twitter`:** Rename `uiTwitterTheme` to `TwitterEditorTheme`
- πŸ’₯ **BREAKING `remirror/core`:** Rename `HasExtensions` to `ExtensionListParams`
- πŸ’₯ **BREAKING `remirror/core`:** It is now up to extensions to decide whether commands should be active when the editor is editable. `isEditable` method is now passed into the `commands` method as a means of checking.
- πŸ’₯ **BREAKING `@remirror/react-utils`:** Rename `childIsFunction` to `propIsFunction` and make it a _pseudo_ predicate function (returns true when it doesn't throw an error).
- πŸ’₯ **BREAKING `@remirror/react`:** Rename `setChildAsRoot` to `childAsRoot` on `RemirrorContextProviderProps` and all it consumers. This affects the `RemirrorContextProvider`, `RemirrorProvider` and `ManagedRemirrorProvider` exports. The prop now can take a boolean or the object with props to inject into the root.
- πŸ’₯ **BREAKING `@remirror/editor-twitter`:** Rename `uiTwitterTheme` to `TwitterEditorTheme`.
- πŸ’₯ **BREAKING `@remirror/core`:** Rename `HasExtensions` to `ExtensionListParams`.
- πŸ’₯ **BREAKING `@remirror/core`:** It is now up to extensions to decide whether commands should be active when the editor is editable. `isEditable` method is now passed into the `commands` method as a means of checking.
- πŸ’₯ **BREAKING `@remirror/react`:** All RemirrorProviders now require a `children` prop. This prevents a bug when rendering in non-dom environments.
- πŸ’₯ **BREAKING `remirror/core`:** Rename `getEditorState` to `getState`
- πŸ’₯ **BREAKING `remirror/core`:** Rename `getPortalContainer` to `getPortals`

- πŸ› `remirror/core`: Fix bug with extension manager failing to provide attributes from the extensions
- πŸ› `remirror/core`: Fix TypeScript type of SSRComponent. Change from `Component` to `ComponentType`
- πŸ› `remirror/editor-twitter`: Fix bug where text area didn't expand to full height of editor container

- Add support for [Git Large File Storage (LFS)](https://git-lfs.github.com/)
- `remirror/editor-twitter`, `remirror/editor-wysiwyg` : Use image-snapshot testing to ensure SSR and DOM rendered editors are identical
- Update husky command from ~~`yarn stop:hooks`~~ and ~~`yarn start:hooks`~~ to `yarn husky:stop` and `yarn husky:start`
- `@remirror/editor-twitter`, `@remirror/editor-wysiwyg` : Use image-snapshot testing to ensure SSR and DOM rendered editors are identical.
- Update husky command from ~~`yarn stop:hooks`~~ and ~~`yarn start:hooks`~~ to `yarn husky:stop` and `yarn husky:start`.

### Remove

- πŸ’₯ **BREAKING `@remirror/react-utils` `@remirror/react` `@remirror/editor-markdown` `@remirror/editor-wysiwyg`:** Remove customRootProp from `RemirrorProps`
- πŸ’₯ **BREAKING `@remirror/react-utils` `@remirror/react` `@remirror/editor-markdown` `@remirror/editor-wysiwyg`:** Remove customRootProp from `RemirrorProps`.
- πŸ’₯ **BREAKING `@remirror/core`:** Remove `isEditable` guard from command functions. It is now up to the command or the caller to decide if it should run when the editor is not editable. To help with this command params with the method `isEditable` are passed to the `commands` method of the extension.
- πŸ’₯ **BREAKING `@remirror/core`:** Remove exports `GetItemParamsMethod`
`createFlexibleFunctionMap` `hasExtensionProperty` `extensionPropertyMapper` `transformExtensionMap` `ignoreFunctions`
`createFlexibleFunctionMap` `hasExtensionProperty` `extensionPropertyMapper` `transformExtensionMap` `ignoreFunctions`.

## [0.2.0] - 2019-06-18

### Added

- Support for server side rendering (SSR) with passing integration tests for NextJS.
- Support for plain extension with styles impacting SSR (PlaceholderExtension can be rendered in SSR).
- **`remirror/core`:** `ssrTransformer` added to extension methods as a way of wrapping and transforming the JSX element produced on the server.
- **`remirror/core`:** `SSRComponent: React.ComponentType<any>` option added to `MarkExtensionOptions` and `NodeExtensionOptions` as a way of overriding the component rendered in an SSR environment.
- **`remirror/core`:** `SSRHelpersExtension` added as a shorthand way of defining SSR transformations via ssrTransformer.
- **`remirror/core`:** `injectBrIntoEmptyParagraphs` added for better SSR rendering.
- **`remirror/react-utils`:** `isReactFragment` added to test if an element is a fragment.
- **`@remirror/core`:** `ssrTransformer` added to extension methods as a way of wrapping and transforming the JSX element produced on the server.
- **`@remirror/core`:** `SSRComponent: React.ComponentType<any>` option added to `MarkExtensionOptions` and `NodeExtensionOptions` as a way of overriding the component rendered in an SSR environment.
- **`@remirror/core`:** `SSRHelpersExtension` added as a shorthand way of defining SSR transformations via ssrTransformer.
- **`@remirror/core`:** `injectBrIntoEmptyParagraphs` added for better SSR rendering.
- **`@remirror/react-utils`:** `isReactFragment` added to test if an element is a fragment.
- Create better unit tests for SSR.
- Add a changelog with changes starting from `v0.1.0`

### Changed

- πŸ’₯ **BREAKING:** Rename `@remirror/ui-*` packages to `@remirror/editor-*` for example @remirror/ui-twitter is .now called `@remirror/editor-twitter`.
- πŸ’₯ **BREAKING `remirror/editor-twitter`:** Rename `UITwitter` and `TwitterUI` to `TwitterEditor`
- πŸ’₯ **BREAKING `remirror/editor-markdown`:** Rename `UIMarkdown` and `MarkdownUI` to `MarkdownEditor`
- πŸ’₯ **BREAKING `remirror/editor-wysiwyg`:** Rename `UIWysiwyg` and `WysiwygUI` to `WysiwygEditor`
- πŸ’₯ **BREAKING `@remirror/editor-twitter`:** Rename `UITwitter` and `TwitterUI` to `TwitterEditor`.
- πŸ’₯ **BREAKING `@remirror/editor-markdown`:** Rename `UIMarkdown` and `MarkdownUI` to `MarkdownEditor`.
- πŸ’₯ **BREAKING `@remirror/editor-wysiwyg`:** Rename `UIWysiwyg` and `WysiwygUI` to `WysiwygEditor`.
- Speed up tslint by enforcing linting on individual modules (new `tsconfig.lint.json` files).
- Remove `cx` import from `emotion` library in from `@remirror/core` to reduce the bundle size.
- Set `@emotion/core` and `@emotion/styled` as peer dependencies.
Expand Down

0 comments on commit dea58ee

Please sign in to comment.