From f7e0ead9465f5583e62c6018cf6cb42ec9d77e99 Mon Sep 17 00:00:00 2001 From: Limon Monte <6059356+limonte@users.noreply.github.com> Date: Tue, 17 Dec 2024 00:10:00 +0200 Subject: [PATCH] chore: add links to official examples --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 597117d..064d401 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,9 @@ Official [SweetAlert2](https://sweetalert2.github.io/) enhancer adding support for React elements as content. -[![Build Status](https://github.com/sweetalert2/sweetalert2-react-content/workflows/build/badge.svg)](https://github.com/sweetalert2/sweetalert2-react-content/actions) -[![npm version](https://img.shields.io/npm/v/sweetalert2-react-content.svg)](https://www.npmjs.com/package/sweetalert2-react-content) +- Simple example: https://sweetalert2.github.io/recipe-gallery/sweetalert2-react.html +- With React Router: https://sweetalert2.github.io/recipe-gallery/sweetalert2-react-router.html +- With react-day-picker: https://sweetalert2.github.io/recipe-gallery/input-datepicker.html [![semantic-release badge](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/sweetalert2/sweetalert2-react-content/blob/main/CHANGELOG.md) [![typescript .d.ts included](https://img.shields.io/badge/typescript-ready-brightgreen.svg)](https://github.com/sweetalert2/sweetalert2-react-content/blob/main/src/sweetalert2-react-content.d.ts) @@ -47,9 +48,3 @@ MySwal.fire({ ``` The `dist/sweetalert2-react-content.umd.js` file defines `window.sweetalert2ReactContent` in non-CJS/AMD environments. - -## Limitations - -SweetAlert2 renders its content outside of the `ReactTree`. In order to render React Router components (such as `Link`) you have to wrap them in the routing context which should be the same with the app. - -That can be achived by using the [`HistoryRouter`](https://reactrouter.com/docs/en/v6/routers/history-router) with shared `history`. [Please refer to the official code example ↗️](https://sweetalert2.github.io/recipe-gallery/sweetalert2-react-router.html)