diff --git a/README.md b/README.md index 053e8f76..bb17fb93 100644 --- a/README.md +++ b/README.md @@ -21,18 +21,18 @@ We extended the project from the original SlickGrid foundation while also includ - removed jQueryUI requirement in [v3](https://github.com/6pac/SlickGrid/wiki/Major-version-3.0----Removal-of-jQueryUI-requirement-(replaced-by-SortableJS)) (replaced it with [SortableJS](https://sortablejs.github.io/Sortable/)) - removed jQuery requirement in [v4](https://github.com/6pac/SlickGrid/wiki/Major-version-4.0---Removal-of-jQuery-requirement) - modernized the project in [v5](https://github.com/6pac/SlickGrid/wiki/Major-version-5.0-%E2%80%90-ES6-ESM-and-TypeScript-Support) by migrating to TypeScript (we kept IIFE and added ES6/ESM build targets) and we also gave SlickGrid a fresh and more modern look via a new Alpine Theme (CSS/SASS) -- the project now has only 1 required dependency which is [SortableJS](https://sortablejs.github.io/Sortable/) +- the project now has only 1 required small dependency which is [SortableJS](https://sortablejs.github.io/Sortable/) ### Vite Demo You can also see a [ViteJS](https://vite.dev/) demo in the [./vite-demo](https://github.com/6pac/SlickGrid/tree/master/vite-demo) folder (also available via the Stackblitz link below). This Vite demo was created mostly to test the project ESM build and also the SASS imports as well. ### Stackblitz -You can also try out this Vite demo (mentioned just above) live in Stackblitz +You can also try out the Vite demo (mentioned just above) live via Stackblitz [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/6pac/SlickGrid/tree/master/vite-demo) -> Note: there are many more examples in the **[Examples](https://github.com/6pac/SlickGrid/wiki/Examples)** Wiki +> Note: the Stackblitz demo only includes 2 examples, however there are a lot more example in the **[Examples](https://github.com/6pac/SlickGrid/wiki/Examples)** Wiki page ### Examples Check out the **[Examples](https://github.com/6pac/SlickGrid/wiki/Examples)** Wiki for a full list of examples demonstrating new features and use cases, such as dynamic grid creation and editors with third party controls. @@ -41,7 +41,7 @@ Also take a look at the [Wiki](https://github.com/6pac/SlickGrid/wiki) and [Rele _For a basic TypeScript example, take a look at the v5.0 Annoucement & Migration guide shown below and also the [TypeScript Example Wiki](https://github.com/6pac/SlickGrid/wiki/TypeScript-Examples)._ -Here's one of the available examples from Stackblitz just above [Realtime Trading](https://6pac.github.io/SlickGrid/examples/example-trading-esm.html) +Below is one of the available examples from Stackblitz which is mentioned just above ![Realtime Trading Demo](https://github.com/user-attachments/assets/db5303f9-bddf-4418-9906-fa0b11d237bd) @@ -77,7 +77,7 @@ For more CDN links, like controls and plugins, just headover to [jsDevlivr - Sli See [Contributing Guide](https://github.com/6pac/SlickGrid/blob/master/CONTRIBUTING.md) ### E2E Tests with Cypress -We have started to add E2E (end to end) tests in the browser by using [Cypress](https://www.cypress.io/). You can see [here](https://github.com/6pac/SlickGrid/tree/master/cypress/e2e) the list of Examples that now have E2E tests. We also run these tests in the [GitHub Actions](https://github.com/features/actions) Workflow (CI) on every Pull Request to avoid committing changes that might break the library. We currently have tests for over 30+ examples with over 350+ tests. +A lot of our Examples now have [Cypress](https://www.cypress.io/) E2E (end to end) tests in the browser. You can see [here](https://github.com/6pac/SlickGrid/tree/master/cypress/e2e) the complete list of Examples that now have E2E tests. The biggest advantage is that these tests are executed in the [GitHub Actions](https://github.com/features/actions) Workflow (CI) for every Pull Request and that is to avoid committing changes that might break the library. We currently have tests for over 35+ examples with about 400 tests. We welcome any new contributions and if you wish to add Cypress E2E tests, all you need to do is to clone the repo and run the following commands ```bash @@ -96,7 +96,7 @@ Once the Cypress UI is open, you can then click on "Run all Specs" to execute al | 5.x | [Announcing v5.0](https://github.com/6pac/SlickGrid/wiki/Major-version-5.0-%E2%80%90-ES6-ESM-and-TypeScript-Support) | project modernization, we added TypeScript with ES6, ESM builds and also a new Alpine Theme | ## CSP Compliance -The library is now, at least for the most part, CSP (Content Security Policy) compliant since `v5.5.0`, however there are some exceptions to be aware of. When using any html string as template (for example with Custom Formatter returning an html string), you will not be fully compliant unless you return `TrustedHTML`. You can achieve this by using the `sanitizer` method in combo with [DOMPurify](https://github.com/cure53/DOMPurify) to return `TrustedHTML`, for more info please take a look at the [CSP Compliance](https://github.com/6pac/SlickGrid/wiki/CSP-Compliance) Wiki. +The library is now, at least for the most part, CSP (Content Security Policy) compliant since `v5.5.0`, however there are some exceptions to be aware of. When using any html strings as template (for example with Custom Formatter returning an html string), you will not be fully compliant unless you return `TrustedHTML`. You can achieve this by using the `sanitizer` method in combo with [DOMPurify](https://github.com/cure53/DOMPurify) to return [`TrustedHTML`](https://developer.mozilla.org/en-US/docs/Web/API/TrustedHTML) and for more info, you can take a look at the [CSP Compliance](https://github.com/6pac/SlickGrid/wiki/CSP-Compliance) Wiki. ### Quick Little Fun Survey ✨ We are conducting a small little poll for fun, it is a single question survey about our latest releases. Thanks for taking the time to participate.