UNPKG

react-markdown

Version:
448 lines (255 loc) 11.3 kB
# Change Log All notable changes will be documented in this file. ## 4.2.2 - 2019-09-03 ### Fixes - (Typings) Inline `RemarkParseOptions` for now (Espen Hovlandsdal) ## 4.2.1 - 2019-09-01 ### Fixes - (Typings) Fix incorrect import - `RemarkParseOptions` (Jakub Chrzanowski) ## 4.2.0 - 2019-09-01 ### Added - Add support for plugins that use AST transformations (Frankie Ali) ### Fixes - (Typings) Add `parserOptions` to type defintions (Ted Piotrowski) - Allow renderer to be any React element type (Nathan Bierema) ## 4.1.0 - 2019-06-24 ### Added - Add prop `parserOptions` to specify options for remark-parse (Kelvin Chan) ## 4.0.9 - 2019-06-22 ### Fixes - (Typings) Make transformLinkUri & transformImageUri actually nullable (Florentin Luca Rieger) ## 4.0.8 - 2019-04-14 ### Fixes - Fix HTML parsing of elements with a single child vs. multiple children (Nicolas Venegas) ## 4.0.7 - 2019-04-14 ### Fixes - Fix matching of replaced non-void elements in HTML parser plugin (Nicolas Venegas) - Fix HTML parsing of multiple void elements (Nicolas Venegas) - Fix void element children invariant violation (Nicolas Venegas) ## 4.0.6 - 2019-01-04 ### Fixes - Mitigate regex ddos by upgrading html-to-react (Christoph Werner) - Update typings to allow arbitrary node types (Jesse Pinho) - Readme: Add note about only parsing plugins working (Vincent Tunru) ## 4.0.4 - 2018-11-30 ### Changed - Upgrade dependencies (Espen Hovlandsdal) ## 4.0.3 - 2018-10-11 ### Fixes - Output paragraph element for last item in loose list (Jeremy Moseley) ## 4.0.2 - 2018-10-05 ### Fixes - Fix text rendering in React versions lower than or equal to 15 (Espen Hovlandsdal) ## 4.0.1 - 2018-10-03 ### Fixes - [TypeScript] Fix TypeScript index signature for renderers (Linus Unnebäck) ## 4.0.0 - 2018-10-03 ### BREAKING - `text` is now a first-class node + renderer - if you are using `allowedNodes`, it needs to be included in this list. Since it is now a React component, it will be passed an object of props instead of the old approach where a string was passed. `children` will contain the actual text string. - On React >= 16.2, if no `className` prop is provided, a fragment will be used instead of a div. To always render a div, pass `'div'` as the `root` renderer. - On React >= 16.2, escaped HTML will no longer be rendered with div/span containers - The UMD bundle now exports the component as `window.ReactMarkdown` instead of `window.reactMarkdown` ### Added - HTML parser plugin for full HTML compatibility (Espen Hovlandsdal) ### Fixes - URI transformer allows uppercase http/https URLs (Liam Kennedy) - [TypeScript] Strongly type the keys of `renderers` (Linus Unnebäck) ## 3.6.0 - 2018-09-05 ### Added - Add support for passing index info to renderers (Beau Roberts) ## 3.5.0 - 2018-09-03 ### Added - Allow specifying `target` attribute for links (Marshall Smith) ## 3.4.1 - 2018-07-25 ### Fixes - Bump dependency for mdast-add-list-metadata as it was using ES6 features (Espen Hovlandsdal) ## 3.4.0 - 2018-07-25 ### Added - Add more metadata props to list and listItem (André Staltz) - list: `depth` - listItem: `ordered`, `index` ### Fixes - Make `source` property optional in typescript definition (gRoberts84) ## 3.3.4 - 2018-06-19 ### Fixes - Fix bug where rendering empty link references (`[][]`) would fail (Dennis S) ## 3.3.3 - 2018-06-14 ### Fixes - Fix bug where unwrapping certain disallowed nodes would fail (Petr Gazarov) ## 3.3.2 - 2018-05-07 ### Changes - Add `rawSourcePos` property for passing structured source position info to renderers (Espen Hovlandsdal) ## 3.3.1 - 2018-05-07 ### Changes - Pass properties of unknown nodes directly to renderer (Jesse Pinho) - Update TypeScript definition and prop types (ClassicDarkChocolate) ## 3.3.0 - 2018-03-06 ### Added - Add support for fragment renderers (Benjamim Sonntag) ## 3.2.2 - 2018-02-26 ### Fixes - Fix language escaping in code blocks (Espen Hovlandsdal) ## 3.2.1 - 2018-02-21 ### Fixes - Pass the React key into an overridden text renderer (vanchagreen) ## 3.2.0 - 2018-02-12 ### Added - Allow overriding text renderer (Thibaud Courtoison) ## 3.1.5 - 2018-02-03 ### Fixes - Only use first language from code block (Espen Hovlandsdal) ## 3.1.4 - 2017-12-30 ### Fixes - Enable transformImageUri for image references (evoye) ## 3.1.3 - 2017-12-16 ### Fixes - Exclude babel config from npm package (Espen Hovlandsdal) ## 3.1.2 - 2017-12-16 ### Fixes - Fixed partial table exception (Alexander Wong) ## 3.1.1 - 2017-12-11 ### Fixes - Add readOnly property to checkboxes (Phil Rajchgot) ## 3.1.0 - 2017-11-30 ### Added - Support for checkbox lists (Espen Hovlandsdal) ### Fixes - Better typings (Igor Kamyshev) ## 3.0.1 - 2017-11-21 ### Added - _Experimental_ support for plugins (Espen Hovlandsdal) ### Changes - Provide more arguments to `transformLinkUri`/`transformImageUri` (children, title, alt) (mudrz) ## 3.0.0 - 2017-11-20 ### Notes - **FULL REWRITE**. Changed parser from CommonMark to Markdown. Big, breaking changes. See _BREAKING_ below. ### Added - Table support! - New types: `table`, `tableHead`, `tableBody`, `tableRow`, `tableCell` - New type: `delete` (`~~foo~~`) - New type: `imageReference` - New type: `linkReference` - New type: `definition` - Hacky, but basic support for React-native rendering of attributeless HTML nodes (`<kbd>`, `<sub>` etc) ### BREAKING - Container props removed (`containerTagName`, `containerProps`), override `root` renderer instead - `softBreak` option removed. New solution will be added at some point in the future. - `escapeHtml` is now TRUE by default - `HtmlInline`/`HtmlBlock` are now named `html` (use `isBlock` prop to check if inline or block) - Renderer names are camelcased and in certain cases, renamed. For instance: - `Emph` => `emphasis` - `Item` => `listItem` - `Code` => `inlineCode` - `CodeBlock` => `code` - `linebreak`/`hardbreak` => `break` - All renderers: `literal` prop is now called `value`\* List renderer: `type` prop is now a boolean named `ordered` (`Bullet` => `false`, `Ordered` => `true`) - `walker` prop removed. Code depending on this will have to be rewritten to use the `astPlugins` prop, which functions differently. - `allowNode` has new arguments (node, index, parent) - node has different props, see renderer props - `childBefore` and `childAfter` props removed. Use `root` renderer instead. - `parserOptions` removed (new parser, so the old options doesn't make sense anymore) ## 2.5.1 - 2017-11-11 ### Changes - Fix `<br/>` not having a node key (Alex Zaworski) ## 2.5.0 - 2017-04-10 ### Changes - Fix deprecations for React v15.5 (Renée Kooi) ## 2.4.6 - 2017-03-14 ### Changes - Fix too strict TypeScript definition (Rasmus Eneman) - Update JSON-loader info in readme to match webpack 2 (Robin Wieruch) ### Added - Add ability to pass options to the CommonMark parser (Evan Hensleigh) ## 2.4.4 - 2017-01-16 ### Changes - Fixed TypeScript definitions (Kohei Asai) ## 2.4.3 - 2017-01-12 ### Added - Added TypeScript definitions (Ibragimov Ruslan) ## 2.4.2 - 2016-07-09 ### Added - Added UMD-build (`umd/react-markdown.js`) (Espen Hovlandsdal) ## 2.4.1 - 2016-07-09 ### Changes - Update `commonmark-react-renderer`, fixing a bug with missing nodes (Espen Hovlandsdal) ## 2.4.0 - 2016-07-09 ### Changes - Plain DOM-node renderers are now given only their respective props. Fixes warnings when using React >= 15.2 (Espen Hovlandsdal) ### Added - New `transformImageUri` option allows you to transform URIs for images. (Petri Lehtinen) ## 2.3.0 - 2016-06-06 ## Added - The `walker` instance is now passed to the `walker` callback function (Riku Rouvila) ## 2.2.0 - 2016-04-20 - Add `childBefore`/`childAfter` options (Thomas Lindstrøm) ## 2.1.1 - 2016-03-25 - Add `containerProps` option (Thomas Lindstrøm) ## 2.1.0 - 2016-03-12 ### Changes - Join sibling text nodes into one text node (Espen Hovlandsdal) ## 2.0.1 - 2016-02-21 ### Changed - Update `commonmark-react-renderer` dependency to latest version to add keys to all elements and simplify custom renderers. ## 2.0.0 - 2016-02-21 ### Changed - **Breaking change**: The renderer now requires Node 0.14 or higher. This is because the renderer uses stateless components internally. - **Breaking change**: `allowNode` now receives different properties in the options argument. See `README.md` for more details. - **Breaking change**: CommonMark has changed some type names. `Html` is now `HtmlInline`, `Header` is now `Heading` and `HorizontalRule` is now `ThematicBreak`. This affects the `allowedTypes` and `disallowedTypes` options. - **Breaking change**: A bug in the `allowedTypes`/`disallowedTypes` and `allowNode` options made them only applicable to certain types. In this version, all types are filtered, as expected. - **Breaking change**: Link URIs are now filtered through an XSS-filter by default, prefixing "dangerous" protocols such as `javascript:` with `x-` (eg: `javascript:alert('foo')` turns into `x-javascript:alert('foo')`). This can be overridden with the `transformLinkUri`-option. Pass `null` to disable the feature or a custom function to replace the built-in behaviour. ### Added - New `renderers` option allows you to customize which React component should be used for rendering given types. See `README.md` for more details. (Espen Hovlandsdal / Guillaume Plique) - New `unwrapDisallowed` option allows you to select if the contents of a disallowed node should be "unwrapped" (placed into the disallowed node position). For instance, setting this option to true and disallowing a link would still render the text of the link, instead of the whole link node and all it's children disappearing. (Espen Hovlandsdal) - New `transformLinkUri` option allows you to transform URIs in links. By default, an XSS-filter is used, but you could also use this for use cases like transforming absolute to relative URLs, or similar. (Espen Hovlandsdal) ## 1.2.4 - 2016-01-28 ### Changed - Rolled back dependencies because of breaking changes ## 1.2.3 - 2016-01-24 ### Changed - Updated dependencies for both `commonmark` and `commonmark-react-parser` to work around an embarrasing oversight on my part. ## 1.2.2 - 2016-01-08 ### Changed - Reverted change from 1.2.1 that uses the dist version. Instead, documentation is added that specified the need for `json-loader` to be enabled when using webpack. ## 1.2.1 - 2015-12-29 ### Fixed - Use pre-built (dist version) of commonmark renderer in order to work around JSON-loader dependency. ## 1.2.0 - 2015-12-16 ### Added - Added new `allowNode`-property. See README for details. ## 1.1.4 - 2015-12-14 ### Fixed - Set correct `libraryTarget` to make UMD builds work as expected ## 1.1.3 - 2015-12-14 ### Fixed - Update babel dependencies and run prepublish only as actual prepublish, not install ## 1.1.1 - 2015-11-28 ### Fixed - Fixed issue with React external name in global environment (`react` vs `React`) ## 1.1.0 - 2015-11-22 ### Changed - Add ability to allow/disallow specific node types (`allowedTypes`/`disallowedTypes`) ## 1.0.5 - 2015-10-22 ### Changed - Moved React from dependency to peer dependency.