@instructure/canvas-rce 5.6.16 → 5.7.0

package/CHANGELOG.md

@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 5.7.0 - 2023-07-18
+
+### Fixed
+- Some broken translations in the 'Edit Course Link' tray and the word count modal
+- Some Typescript errors
+- An issue where the a11y checker incorrectly shows the issues icon
+
+### Changed
+- Removed the `rce_new_external_tool_dialog_in_canvas` feature flag
+- Removed the deprecated `instructure_external_tools` package code which was not in use
+- Replaced themeable with emotion
+
+### Added
+- Selected link indicator alert for screenreaders in the 'Edit Course Link' tray
+
+## 5.6.17 - 2023-06-27
+
+### Fixed
+- Added some missing media translations
+- Fixed some a11y/usability issues in the 'Edit Course Link' tray
+- Fixed an icon maker bug related to image compression
+- Fixed some issues related to pasting images in Firefox and embedding media
+
+### Changed
+- Removed the `rce_improved_placeholders`, `rce_better_paste`, `rce_show_studio_media_options`, and
+  `buttons_and_icons_cropper` feature flags
+- Improved the accessibility checker's performance
+
 ## 5.6.16 - 2023-05-17
 
 ### Fixed

package/README.md

@@ -1,49 +1,41 @@
 # Canvas Rich Content Editor
 
-The Canvas LMS Rich Content Editor extracted in it's own npm package for use
-across multiple services. In the canvas ecosystem, this npm module is used
-in pair with a running `canvas-rce-api` microservice.
+> The Canvas LMS Rich Content Editor (RCE) extracted in it's own npm package for use across multiple services
 
-Some features require a running instance of the `canvas-rce-api`,
-but you do not need that instance in order to
-do development on `canvas-rce`. (see [docs/development.md](docs/development.md))
+In the Canvas ecosystem, this npm module is used in conjunction with the Rich Content Service (RCS) microservice. The code for the RCS is also open source and lives in the `canvas-rce-api` repository. (see https://github.com/instructure/canvas-rce-api)
 
-The first customer of the `canvas-rce` is the `canvas-lms` LMS so documentation
-and references throughout documentation might reflect and assume the use of
-`canvas-lms`.
+Some features require a running instance of the `canvas-rce-api`, but you do not need an instance in order to do development on `@instructure/canvas-rce`. (see the [Development section](#development))
 
-## Install and setup
+The primary consumer of the `@instructure/canvas-rce` is `canvas-lms`, so documentation
+and references throughout documentation might reflect and assume the use of `canvas-lms`.
 
-As a published npm module, you can add canvas-rce to your node project by doing
+## Install and Setup
+
+As a published npm module, you can add `@instructure/canvas-rce` to your node project by doing
 the following:
 
 ```bash
-npm install canvas-rce --save
+npm install @instructure/canvas-rce --save
 ```
 
-For guidance on how `canvas-rce` is used within canvas, please reference
-the [canvas-lms use of canvas-rce](https://github.com/instructure/canvas-lms/tree/stable/ui/shared/rce)
-to get an idea on how to incorporate it into your project. Pay
+For guidance on how `@instructure/canvas-rce` is used within Canvas, please reference
+the [canvas-lms use of canvas-rce](https://github.com/instructure/canvas-lms/tree/master/ui/shared/rce) to get an idea on how to incorporate it into your project. Pay
 special attention to the `RichContentEditor.js` and `serviceRCELoader.js`.
 
-Outside of canvas, the `CanvasRce` React component is your entry point.
-_Work is ongoing to make the props to `CanvasRce` more rational.
-Please be patient._
+Outside of Canvas, the `CanvasRce` React component is your entry point.
 
 ## Tests
 
-While canvas consumes the es modules build of the rce,
-Jest tests are run against the commonjs build, so make sure you've built the
-commonjs assets before running tests:
+First, build assets. Then you can run the tests:
 
 ```bash
-yarn build:canvas
+yarn build:all
 yarn test:jest
 ```
 
-There are still legacy mocha tests run with `yarn test:mocha`. `yarn test` runs them all.
+There are still legacy mocha tests run with `yarn test:mocha`. The command `yarn test` runs them all.
 
-### test debugging hints
+### Test Debugging Hints
 
 ```
 yarn test:jest:debug path/to/__test__/file.test.js
@@ -62,23 +54,22 @@ while you iterate.
 
 ## Polyfills
 
-This project makes use of modern JavaScript APIs like Promise, Object.assign,
-Array.prototype.includes, etc. which are present in modern
+This project makes use of modern JavaScript APIs like `Promise`, `Object.assign`,
+`Array.prototype.includes`, etc. which are present in modern
 browsers but may not be present in old browsers like IE 11. In order to not
 send unnecessarily large and duplicated code bundles to the browser, consumers
 are expected to have already globally polyfilled those APIs.
-Canvas only supports modern browsers and the rce has not been tested
+Canvas only supports modern browsers and the RCE has not been tested
 in older browsers like IE. If you need suggestions for how to include
-polyfills in your
-own app, you can just put this in your html above the script that includes
-canvas-rce:
+polyfills in your own app, you can put this in your html above the script that includes
+`@instructure/canvas-rce`:
 
 ```
 <script src="https://cdn.polyfill.io/v2/polyfill.min.js?rum=0"></script>
 ```
 
-(See: https://polyfill.io/v2/docs/ for more info)
+(See https://polyfill.io/v2/docs/ for more info)
 
 ## Development
 
-See [DEVELOPMENT.md](./DEVELOPMENT.md)
+See [DEVELOPMENT.md](https://github.com/instructure/canvas-lms/blob/master/packages/canvas-rce/DEVELOPMENT.md)

package/canvas/README.md

@@ -0,0 +1,84 @@
+# Canvas Rich Content Editor
+
+The Canvas LMS Rich Content Editor extracted in it's own npm package for use
+across multiple services. In the canvas ecosystem, this npm module is used
+in pair with a running `canvas-rce-api` microservice.
+
+Some features require a running instance of the `canvas-rce-api`,
+but you do not need that instance in order to
+do development on `canvas-rce`. (see [docs/development.md](docs/development.md))
+
+The first customer of the `canvas-rce` is the `canvas-lms` LMS so documentation
+and references throughout documentation might reflect and assume the use of
+`canvas-lms`.
+
+## Install and setup
+
+As a published npm module, you can add canvas-rce to your node project by doing
+the following:
+
+```bash
+npm install canvas-rce --save
+```
+
+For guidance on how `canvas-rce` is used within canvas, please reference
+the [canvas-lms use of canvas-rce](https://github.com/instructure/canvas-lms/tree/stable/ui/shared/rce)
+to get an idea on how to incorporate it into your project. Pay
+special attention to the `RichContentEditor.js` and `serviceRCELoader.js`.
+
+Outside of canvas, the `CanvasRce` React component is your entry point.
+_Work is ongoing to make the props to `CanvasRce` more rational.
+Please be patient._
+
+## Tests
+
+While canvas consumes the es modules build of the rce,
+Jest tests are run against the commonjs build, so make sure you've built the
+commonjs assets before running tests:
+
+```bash
+yarn build:canvas
+yarn test:jest
+```
+
+There are still legacy mocha tests run with `yarn test:mocha`. `yarn test` runs them all.
+
+### test debugging hints
+
+```
+yarn test:jest:debug path/to/__test__/file.test.js
+```
+
+will break and wait for you to attach a debugger (e.g. `chrome://inspect/#devices`).
+
+Similarly, for mocha tests
+
+```
+yarn test:mocha:debug path/to/test/file.test.js
+```
+
+Both those commands may include a `--watch` argument to keep the process alive
+while you iterate.
+
+## Polyfills
+
+This project makes use of modern JavaScript APIs like Promise, Object.assign,
+Array.prototype.includes, etc. which are present in modern
+browsers but may not be present in old browsers like IE 11. In order to not
+send unnecessarily large and duplicated code bundles to the browser, consumers
+are expected to have already globally polyfilled those APIs.
+Canvas only supports modern browsers and the rce has not been tested
+in older browsers like IE. If you need suggestions for how to include
+polyfills in your
+own app, you can just put this in your html above the script that includes
+canvas-rce:
+
+```
+<script src="https://cdn.polyfill.io/v2/polyfill.min.js?rum=0"></script>
+```
+
+(See: https://polyfill.io/v2/docs/ for more info)
+
+## Development
+
+See [DEVELOPMENT.md](./DEVELOPMENT.md)