From 7191089ab98495eee4802b670c5cff2f2e87a9c4 Mon Sep 17 00:00:00 2001 From: Charlie Brown Date: Wed, 31 Jan 2024 09:18:50 -0600 Subject: [PATCH] Use legacy npm dist-tag to avoid conflicts with victory-native-xl (#2764) --- .changeset/pink-hats-count.md | 5 +++++ docs/src/content/introduction/native.md | 6 +++--- packages/victory-native/README.md | 3 +-- packages/victory-native/package.json | 3 ++- packages/victory/README.md | 5 +++-- 5 files changed, 14 insertions(+), 8 deletions(-) create mode 100644 .changeset/pink-hats-count.md diff --git a/.changeset/pink-hats-count.md b/.changeset/pink-hats-count.md new file mode 100644 index 000000000..f5f6c5326 --- /dev/null +++ b/.changeset/pink-hats-count.md @@ -0,0 +1,5 @@ +--- +"victory-native": patch +--- + +Use legacy npm dist-tag to avoid conflicts with victory-native-xl diff --git a/docs/src/content/introduction/native.md b/docs/src/content/introduction/native.md index b11c74b41..5328410a1 100644 --- a/docs/src/content/introduction/native.md +++ b/docs/src/content/introduction/native.md @@ -8,8 +8,8 @@ scope: null # Getting Started with Victory Native -> These docs are for the legacy versions of Victory Native. If you're looking for Victory Native XL docs, please [see here] -(https://formidable.com/open-source/victory-native/). +> These docs are for the legacy versions of Victory Native. Victory Native XL is our rewrite of Victory Native designed specifically for React Native. Please [see here for more information] +(https://formidable.com/open-source/victory-native/). If you would like to continue to use this version of Victory with React Native, follow the legacy guide below. In this guide, we’ll show you how to get started with Victory Native and the React Native SVG dependency running in your React Native app for iOS and Android. @@ -22,7 +22,7 @@ Victory Native is compatible with React Native 0.50 or higher. To add Victory Native to your React Native app install `victory-native`. ```bash -$ yarn add victory-native # or npm install --save victory-native +$ yarn add victory-native@legacy # or npm install --save victory-native@legacy ``` #### 2. Add React Native SVG to your app diff --git a/packages/victory-native/README.md b/packages/victory-native/README.md index 85f3a0cf3..9fccd3a70 100644 --- a/packages/victory-native/README.md +++ b/packages/victory-native/README.md @@ -6,7 +6,7 @@ Install victory-native: ```sh -$ npm install victory-native --save +$ npm install victory-native@legacy --save ``` Install react-native-svg: @@ -96,4 +96,3 @@ Please review our [Code of Conduct][code] before contributing. [victory-native-demo]:https://github.com/FormidableLabs/victory-native-demo [react-native-svg-readme]: https://github.com/react-native-community/react-native-svg#notice [maintenance-image]: https://img.shields.io/badge/maintenance-active-green.svg - diff --git a/packages/victory-native/package.json b/packages/victory-native/package.json index 30a4c91c0..6e954a171 100644 --- a/packages/victory-native/package.json +++ b/packages/victory-native/package.json @@ -65,7 +65,8 @@ "react": ">=16.6.0" }, "publishConfig": { - "provenance": true + "provenance": true, + "tag": "legacy" }, "scripts": { "build": "wireit", diff --git a/packages/victory/README.md b/packages/victory/README.md index e25fbb04d..7e33116c4 100644 --- a/packages/victory/README.md +++ b/packages/victory/README.md @@ -38,8 +38,9 @@ Projects using Victory should also depend on [React][] and [prop-types][]. ## Victory Native -Want to use `Victory` with React Native? Check out [victory-native](https://github.com/FormidableLabs/victory-native) -Victory Native shares most of its code with Victory, and has a nearly identical api! +Want to use `Victory` with React Native? Check out [victory-native-xl](https://github.com/FormidableLabs/victory-native-xl) + +If you would like to use this version of `Victory` with React Native, you can install the legacy version using the `legacy` npm tag. See the [available versions in npm](https://www.npmjs.com/package/victory-native?activeTab=versions). ## [Contributing](CONTRIBUTING.md)