CHANGELOG.md

13.0.0 - 2022-03-04

💥 Breaking

• Dropped IE 11 support. Modern browsers now required.
• Interweave is no longer a default export, and is now a named export.

🚀 Updates

• Added rel attribute to the allow list.
• Added support for React 18.

📦 Dependencies

• Updated to latest packemon.

🛠 Internals

• Migrated to Beemo for build and developer tooling.

12.9.0 - 2021-10-16

🚀 Updates

• Added a transformOnlyAllowList to filter out unknown elements when transforming.

12.8.0 - 2021-07-10

🚀 Updates

• Added a className prop, which is passed to the wrapping element.

🐞 Fixes

• Updated Markup to render a span by default (instead of div). This functionality now matches Interweave and the docs.

12.7.2 - 2021-05-13

🐞 Fixes

• Add an undefined check for global.

📦 Dependencies

• Updated all dependencies.

12.7.1 - 2021-03-07

🐞 Fixes

• Include source folder for source maps work correctly.

12.7.0 - 2021-01-18

🛠 Internals

• Switched to Packemon for package building.
• Updated test data and fixtures.

12.6.0 - 2020-11-04

🚀 Updates

• Added support for React 17.

12.5.0 - 2020-03-19

🚀 Updates

• Add support for an improved form of SSR.
• Enable the loading attribute.

12.4.0 - 2020-03-18

🚀 Updates

• Added an attributes prop to Interweave and Markup in which custom HTML attributes can be passed.

🛠 Internals

• Parser will now no-op during SSR if there is no document and interweave-ssr has not be setup.

12.3.0 - 2020-03-13

🚀 Updates

• Added a match function for handling pre-defined matcher logic.
• Added a noWrap prop that doesn't wrap content with an element (uses React fragments).
• Added a containerTagName prop which allows content to be contextual parsed based on a specific parent tag name (like parsing li within a ul).

12.2.2 - 2020-03-01

📦 Dependencies

• Updated all dependencies.

12.2.1 - 2020-02-06

🐞 Fixes

• Fixed an issue with testing utils where duplicate Interweave instances were being used.

🛠 Internals

• Renamed testUtils to testing.

12.2.0 - 2019-01-25

🚀 Updates

• Migrated build to Rollup for a smaller filesize.

12.1.1 - 2019-11-15

🐞 Fixes

• Add tel: to the list of safe protocols.

12.1.0 - 2019-11-01

🚀 Updates

• Added a greedy option to matchers.
• Added support for void elements (self closing).

12.0.0 - 2019-10-29

💥 Breaking

• Updated react requirement to v16.8.
• Updated Matcher#createElement and Matcher#replaceWith to receive any React node, not just the matched string.
• Updated Matcher#match response structure. Must return index, length, and valid properties.

🚀 Updates

• Added interleaving supports to matchers, which allows for nested elements to be possible. Required a heavy rewrite of the parsing and matching layer, so may incur performance regressions.
• Rewrote all components to use function components. Reduced file sizes by 35%.

📦 Dependencies

• Updated all dependencies.

11.2.0 - 2019-09-23

🚀 Updates

• Added start to the attribute allow list.

📦 Dependencies

• Updated all dependencies.

⚙️ Types

• [TS] Updated Filter#attribute types to extend from React.AllHTMLAttributes.
• [TS] Refined some internal types to not use any.

🛠 Internals

• Migrated from enzyme to rut for React testing.

11.1.0 - 2019-05-09

🚀 Updates

• Added new attributes to allow list: media, scope, srclang, style.
  • Style properties that contain image(), image-set(), or url() are removed.
• Namespace and data attributes are also now rendered.

🐞 Fixes

• Fixed many parent <-> child relationships as part of the new rendering hierarchy.
• figure now supports all flow content.
• header can now be rendered at the root.

🛠 Internals

• Filters are now applied after attributes have been type casted, instead of before.

11.0.1 - 2019-05-06

🐞 Fixes

• Removed canvas and iframe from the default allow list (they should have been opt-in).
• [TS] Fixed some default props issues.

🛠 Internals

• Updated all @types dependencies to use * version.

11.0.0 - 2019-04-26

The previous version of Interweave would attempt to render valid parent and child hierarchies based on their inline, block, and inline-block presentation. This worked for the majority, but broke down hard in minority edge cases. This valid rendering hierarchy has been rewritten from the ground up using content categories. Because of this, some old HTML may now be invalid, while some additional HTML tags are now renderable.

💥 Breaking

• Updated IE requirement to v11.
• Renamed TAGS_BLACKLIST to BANNED_TAG_LIST.
• Removed PARSER_ALLOW, PARSER_DENY, TYPE_INLINE, TYPE_BLOCK, TYPE_INLINE_BLOCK, CONFIG_INLINE, and CONFIG_BLOCK constants.
• Removed disableWhitelist prop. Use allowAttributes or allowElements instead.
• Removed iframe and canvas tags from the banned list. They are not in the default allow list but can be enabled by the consumer.

🚀 Updates

• Parser and Element are now exported from the index.
• Added TYPE_FLOW, TYPE_SECTION, TYPE_HEADING, TYPE_PHRASING, TYPE_EMBEDDED, TYPE_INTERACTIVE, and TYPE_PALPABLE constants.
• Added allowAttributes prop, which disables all non-banned HTML attribute filtering.
• Added allowElements prop, which disables all non-banned HTML element filtering.
• Added allowList prop, which only enables specific HTML elements. Defaults to the ALLOWED_TAG_LIST constant.
• Added blockList prop, which disables specific HTML elements.
• Added escapeHtml prop, which escapes all HTML before parsing.
• Added support for HTML tags: bdi, bdo, caption, col, colgroup, rb, rp, rt, rtc, ruby, small.

🛠 Internals

• Removed @babel/runtime as it wasn't saving much space.
• [TS] Switched to project references.
• [TS] Updated NodeConfig to match the new rendering strategy.

10.1.3 - 2019-02-25

🐞 Fixes

• More ESM improvements.

🛠 Internals

• Updated dependencies.

10.1.2 - 2019-02-17

🐞 Fixes

• Added missing @babel/runtime package.

10.1.1 - 2019-02-10

🐞 Fixes

• Fixed an issue with TS types being exported from the ESM index.

10.1.0 - 2019-02-09

🚀 Updates

• Added ECMAScript module support via esm/ built files.
• Removed copyright docblocks from source files to reduce bundle size.

🛠 Internals

• Tested with React v16.8.

10.0.0 - 2019-01-08

💥 Breaking

• HTML attributes in which their value is falsy will now be treated as enabled attributes, according the official HTML spec.
• Newlines will now be converted to <br/> tags when noHtmlExceptMatchers is passed.
• PropType shapes have been removed.

🚀 Updates

• Enabled the type attribute for all HTML elements.
• Updated tagName prop to support any JSX supported HTML tag.

🐞 Fixes

• Fixed a bug in which content starting with BBCode ([html]) were not being parsed.

9.2.1 - 2018-08-07

🐞 Fixes

• Added srcSet to the React attribute to prop mapping.

9.2.0 - 2018-08-02

🚀 Updates

• Added srcset and sizes to the attribute whitelist.
• Updated transform to support blacklisted tags as a means to intercept. This allows tags like iframe and canvas to be used when handled manually.

9.1.0 - 2018-07-18

🚀 Updates

TypeScript

• Added a new Node type to resolve React node issues.
  • Only accepts null, string, and React.ReactElement.
  • Replaced all React.ReactNode[] types with Node[].

9.0.0 - 2018-07-10

💥 Breaking

• Updated minimum react requirement to 16.3.
• Updated Interweave to extend React.PureComponent.
• Updated Interweave and Markup prop to default tagName to div (from span).
• Removed className and commonClass props.
  • If you require custom class names, use a Filter and append to the node manually.
• Refactored Matcher factories to use a React component reference, instead of a factory function.

🐞 Fixes

• Fixed issues when null was passed to content.

🛠 Internals

• Converted from Flow to TypeScript.
• Moved documention to Gitbook.

8.1.0 - 2018-04-16

🚀 Updates

• Added a commonClass prop to control the class name for all Interweave elements.
• Added a transform prop to hook into the parsing process.
• Updated tagName prop to accept "fragment", in which a React.Fragment will be rendered.

8.0.2 - 2017-11-10

🐞 Fixes

• Fixed a bug where passing a null content with onBeforeParse would throw errors.

🛠 Internals

• Tested against React 16.1.
• Improved build process.

8.0.1 - 2017-10-23

🛠 Internals

• Fixed dependencies.

8.0.0 - 2017-10-12

💥 Breaking

• The API for filters have changed. Filters now support nodes as well as attributes.
  • The filter() method has been removed.
  • A new attribute(name, value) method has been added (works like the previous implementation).
  • A new node(tagName, node) method has been added.

7.1.0 - 2017-09-26

🚀 Updates

• Updated prop-types to 15.6.

🛠 Internals

• Tested against React 16.

7.0.0 - 2017-09-25

💥 Breaking

• Moved autolinking functionality to a new package, interweave-autolink.
• Moved emoji functionality to a new package, interweave-emoji.
• Updated react peer dependency requirement to 15.3.
• Migrated Markup, Element, Email, Hashtag, Link, and Url components to React.PureComponent.

🚀 Updates

• Matchers can now be defined as objects instead of a class that extends Matcher.
• Filters can now be defined as objects instead of a class that extends Filter.
• Added FilterShape and MatcherShape prop types.

🛠 Internals

• Split Interweave into a multi-package repository using Yarn workspaces and Lerna.
• Major refactor and cleanup on Flowtype usage.

6.1.0 - 2017-08-23

🐞 Fixes

• Major improvements to emoticon matching and parsing.
• Updated Flowtype definitions with more generics.

🛠 Internals

• Updated emojibase to 1.3.0.
• Updated emojibase-regex to 1.0.4.

6.0.0 - 2017-08-21

💥 Breaking

• Migrated from emoji-database to emojibase, which is now a peer dependency.
• Matcher files have been renamed and suffixed with Matcher.
• Renamed all usage of shortname to shortcode.

🚀 Updates

• Added support for React 16.
• Emoji data is now fetched from a CDN instead of being bundled locally.
  • Added new EmojiLoader component to handle the loading of emoji data.
  • Added localized emoji data.
• Emoticon support has been added. Convert emoticons to emoji!
• Updated Emoji component.
  • Added new emoticon prop.
  • Added title, aria-label, and data-emoticon element attributes.
  • Renamed shortname prop to shortcode.
  • Renamed data-shortname to data-shortcodes.
• Updated EmojiMatcher.
  • Added new convertEmoticon option.
  • Renamed convertShortname option to convertShortcode.

🛠 Internals

• Fixed and updated Flowtype and React definitions.

5.4.0 - 2017-07-12

• Updated emoji-database to 0.9.
• Updated enlargeThreshold to ignore whitespace when counting.
• Fixed a bug in which emoji counts below the enlargeThreshold were not being enlarged.

5.3.0 - 2017-07-12

• Added a new emojiLargeSize prop, which can be used to customize the size of enlarged emoji.
  • Also passed as the 4th argument to the emojiPath function.
• Added a new enlargeThreshold option to EmojiMatcher, which determines the number of emojis to automatically enlarge, when emojis are the only content.
• Updated Matcher#onBeforeParse and Matcher#onAfterParse to receives the entire props object as the 2nd argument.
• Wrapped thrown errors in process.env.NODE_ENV !== 'production' environment checks.
• Improvements to Flow definitions.

5.2.0 - 2017-07-10

• Added a new noHtmlExceptMatchers prop.
• Fixed a bug in which matcher after callbacks were not triggering properly.

5.1.2 - 2017-06-02

• Fixed prefixed TLDs not being matched correctly.

5.1.1 - 2017-06-23

• Updated emoji-database to 0.8.
• Fixed IE 10 compiled lib/ issues.

5.1.0 - 2017-06-16

• Updated support for react 15.6.
• Updated emoji-database to 0.7.
• Updated UrlMatcher to validate against a common whitelist of TLDs (no longer wildcard).
• Added customTLDs and validateTLD options to UrlMatcher.

5.0.1 - 2017-05-16

• Fixed an issue with the index import failing.

5.0.0 - 2017-05-10

• Updated IE requirement to 11+.
• Updated to include src/ files in the published package.
• Updated Flow definitions.
• Moved Flow definition to root of project.
• Moved published files to a lib/ folder.

4.1.0 - 2017-04-25

• Updated the emojiPath function to receive enlargeEmoji as the 2nd argument, and emojiSize as the 3rd argument.
• Updated EmojiOne CDN.

4.0.0 - 2017-04-22

• Updated support for React 15.5 and the new prop-types package.
• Updated emoji parsing and rendering to use emoji-database, which also supports EmojiOne 3.0, and the latest emoji unicode specification.
• Updated the Emoji component's rendered img element to use the emoji unicode character as the alt attribute.
• Updated the Emoji component's emojiPath prop to accept a function, which is passed the emoji hexadecimal code (without ZWJ).
• Updated the Hashtag component's hashtagUrl prop to accept a function, which is passed the hashtag.
• Updated all emoji hexadecimal codes to be uppercase.
• Renamed Emoji component prop shortName to shortname.
• Renamed EmojiMatcher option convertShortName to convertShortname.
• Removed the emoji dataset and regex generation from Interweave.
• Fixed a few issues with the flowtype definitions.

3.1.0 - 2017-03-31

• Added an emojiSize prop to the Emoji component, which will scale the size of the emoji using inline styles.
• Updated the Emoji component to return img instead of span.
• Removed the extension specific class name from the Emoji element.

3.0.2 - 2017-03-30

• Fixed an issue with the published build.

3.0.1 - 2017-03-30

• Added support for / and \ in URL query string parsing.

3.0.0 - 2017-03-25

• Updated to no longer support parsing entire HTML documents.
  • This includes content that starts with <!DOCTYPE>, <html>, <head>, and <body>.
  • Will now throw an error if the content is invalid.
• Updated to treat all non-whitelist and non-blacklist tags as pass-through.
  • Will now render children for tags that were not previously supported.
• Added a new disableWhitelist prop to Interweave and Markup components, that disables the automatic HTML tag and attribute filtering.
• Added CONFIG_INLINE and CONFIG_BLOCK constants.
• Removed the PARSER_PASS_THROUGH constant.

2.0.3 - 2017-02-24

• Added Parser#isSafe to verify that a node is safe from injection attacks.
• Fixed an issue with specific anchor link javascript: attacks being permitted.

2.0.2 - 2017-01-27

• Fixed an issue with surrogate pair emojis rendering separately. For example, the MWGB family emoji should now render as a single emoji, instead of 4 individual.
• Improved the efficiency of the emoji regex pattern.

2.0.1 - 2016-12-13

• Fixed an issue with the NPM package.

2.0.0 - 2016-12-12

• Removed the concept of global configuration. Composition should be used instead.
• When an emoji is the only character parsed as the content, it will automatically be enlarged.
• Added a preserveHash prop to the Hashtag component to not strip the hash.
• Added an enlargeEmoji prop to the Emoji component that will append a large class name.
• Added onBeforeParse and onAfterParse callback methods to all matchers.
• Updated the Hashtag component to strip the hash (#) when replacing {{hashtag}}.
• Updated the Emoji component to prefix the file extension class name with interweave__emoji--.
• Removed Interweave#addFilter, addMatcher, clearFilters, clearMatchers, getFilters, getMatchers, and configure.

1.2.0 - 2016-12-15

• Updated emoji to the latest EmojiOne dataset.

1.1.1 - 2016-11-10

• Fixed an issue with the published build.

1.1.0 - 2016-11-10

• Line breaks found in non-HTML strings will now be automatically converted to <br/> tags.
• Added a disableLineBreaks prop to Interweave and Markup, which will disable the automatic line break conversion.
• Added an interweave class to all rendered HTML elements.
• Added an interweave--no-html class when noHtml is enabled.
• Updated the content prop to accept null or undefined values. Will default to an empty string.
• Removed the data-interweave attribute from elements.
• Removed the className prop from Interweave and Markup.
• Fixed an issue where void elements (br, hr, etc) would not render correctly.

1.0.1 - 2016-10-21

• Fixed an issue in which empty parses would pass an empty child to Element, triggering a prop type failure.

1.0.0 - 2016-10-20

• Initial release!