diff --git a/.storybook/preview-head.html b/.storybook/preview-head.html deleted file mode 100644 index 80acaa30..00000000 --- a/.storybook/preview-head.html +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/README.md b/README.md index 67fa614c..505f7b46 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,6 @@ yarn add @shopify/discount-app-components ```js import {Page, AppProvider as PolarisAppProvider} from '@shopify/polaris'; - import {Provider as AppBridgeProvider} from '@shopify/app-bridge-react'; import {AppProvider as DiscountsProvider} from '@shopify/discount-app-components'; // See [Polaris AppProvider documentation](https://github.com/Shopify/polaris/blob/main/polaris-react/src/components/AppProvider/README.md#using-translations) for more details on using Polaris translations diff --git a/src/components/AppProvider/README.md b/src/components/AppProvider/README.md index c604fc17..982e8e70 100644 --- a/src/components/AppProvider/README.md +++ b/src/components/AppProvider/README.md @@ -2,23 +2,12 @@ App provider is a required component that enables sharing global settings throughout the hierarchy of your application. ---- - -## Usage and best practices - -The app provider component is required to use `@shopify/discount-app-components`. Without it the components in your application will not function correctly. You must wrap the root (the top) of your application in the app provider component. - -This project uses [@shopify/polaris](https://github.com/Shopify/polaris) and [@shopify/app-bridge-react](https://github.com/Shopify/app-bridge/tree/main/packages/app-bridge-react) under the hood, so you will also need to wrap your app root in the [Polaris AppProvider](https://github.com/Shopify/polaris/blob/main/polaris-react/src/components/AppProvider/README.md) and the [AppBridge Provider](https://github.com/Shopify/app-bridge/blob/main/packages/app-bridge-react/src/components/Provider/README.md). - ---- - ## Examples ### Usage ```js import {Page, AppProvider as PolarisAppProvider} from '@shopify/polaris'; -import {Provider as AppBridgeProvider} from '@shopify/app-bridge-react'; import {AppProvider} from '@shopify/discount-app-components'; // See [Polaris AppProvider documentation](https://github.com/Shopify/polaris/blob/main/polaris-react/src/components/AppProvider/README.md#using-translations) for more details on using Polaris translations @@ -35,7 +24,6 @@ export default function App() { ... return ( - @@ -43,7 +31,6 @@ export default function App() { - ); } ``` diff --git a/src/components/README.md b/src/components/README.md index cd686805..cbc990dc 100644 --- a/src/components/README.md +++ b/src/components/README.md @@ -1,6 +1,6 @@ # Components -Our components are a collection of interface elements that can be reused and composed to build discounts-focused [AppBridge](https://shopify.dev/apps/tools/app-bridge) apps. +Our components are a collection of interface elements that can be reused and composed to build discounts-focused apps. --- diff --git a/src/stories/foundation/Provider.tsx b/src/stories/foundation/Provider.tsx index c2ba0df8..5b6ef479 100644 --- a/src/stories/foundation/Provider.tsx +++ b/src/stories/foundation/Provider.tsx @@ -5,7 +5,6 @@ import enPolarisTranslations from '@shopify/polaris/locales/en.json'; import '@shopify/polaris/build/esm/styles.css'; import {AppProvider as PolarisAppProvider} from '@shopify/polaris'; -// import {Provider as AppBridgeProvider} from '@shopify/app-bridge-react'; import {AppProvider} from '../../components/AppProvider'; export function Provider({children}: {children: React.ReactNode}) {