@graphcommerce/docs 6.0.0-canary.43 → 6.0.0-canary.45

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 6.0.0-canary.45
+
+## 6.0.0-canary.44
+
+### Patch Changes
+
+- [#1842](https://github.com/graphcommerce-org/graphcommerce/pull/1842) [`7b67d84bd`](https://github.com/graphcommerce-org/graphcommerce/commit/7b67d84bd269c3fc91afbd69f6683c5d12808d36) - Renamed i18n to storefront in configuration ([@paales](https://github.com/paales))
+
 ## 6.0.0-canary.43
 
 ## 6.0.0-canary.42

package/framework/config.md

@@ -13,21 +13,21 @@ The configuration file is a javascript file that exports a `GraphCommerceConfig`
 Configuration can be accessed in your project with the `import.meta.graphCommerce` object.
 
 ```tsx
-import { i18nAll, i18nConfig, i18nConfigDefault, useI18nConfig } from '@graphcommerce/next-ui'
+import { storefrontAll, storefrontConfig, storefrontConfigDefault, useStorefrontConfig } from '@graphcommerce/next-ui'
 
 // Accessing a global value
 const globalConf = import.meta.graphCommerce.cartDisplayPricesInclTax
 
 function MyComponent() {
-  // Configuration configured per i18n locale.
-  const scopedConfig = useI18nConfig().cartDisplayPricesInclTax
+  // Configuration configured per storefront locale.
+  const scopedConfig = useStorefrontConfig().cartDisplayPricesInclTax
 
   // Creating a fallback system
   const scopedConfigWithFallback = scopedConfig ?? globalConf
 
   // Or as single line
   const scopedConfigWithFallback2 =
-    useI18nConfig().cartDisplayPricesInclTax ?? import.meta.graphCommerce.cartDisplayPricesInclTax
+    useStorefrontConfig().cartDisplayPricesInclTax ?? import.meta.graphCommerce.cartDisplayPricesInclTax
 
   return <div>{googleRecaptchaKey}</div>
 }
@@ -50,7 +50,7 @@ Configuration values can be overwriten by environment variables, with the follow
 
 Examples:
 - `limitSsg` -> `GC_LIMIT_SSG="1"`
-- `i18n[0].locale` -> `GC_I18N_0_LOCALE="en"`
+- `storefront[0].locale` -> `GC_STOREFRONT_0_LOCALE="en"`
 - `debug.pluginStatus` -> `GC_DEBUG_PLUGIN_STATUS="1"`
 
 
@@ -60,7 +60,7 @@ You can export configuration by running `yarn graphcommerce export-config`
 
 ## Extending the configuration in your  project
 
-Create a graphql/Config.graphqls file in your project and extend the GraphCommerceConfig, GraphCommerceI18nConfig inputs to add configuration.
+Create a graphql/Config.graphqls file in your project and extend the GraphCommerceConfig, GraphCommerceStorefrontConfig inputs to add configuration.
 
 ```graphql
 extend input GraphCommerceConfig {
@@ -73,7 +73,7 @@ extend input GraphCommerceConfig {
   myOptionalFloat: Float
   myRequiredFloat: Float!
 }
-extend input GraphCommerceI18nConfig {
+extend input GraphCommerceStorefrontConfig {
   myField: Boolean
 }
 ```
@@ -99,10 +99,6 @@ The HyGraph endpoint.
 
 Project settings -> API Access -> High Performance Read-only Content API
 
-#### `i18n: [[GraphCommerceI18nConfig](#GraphCommerceI18nConfig)!]!`
-
-All i18n configuration for the project
-
 #### `magentoEndpoint: String!`
 
 GraphQL Magento endpoint.
@@ -110,6 +106,10 @@ GraphQL Magento endpoint.
 Examples:
 - https://magento2.test/graphql
 
+#### `storefront: [[GraphCommerceStorefrontConfig](#GraphCommerceStorefrontConfig)!]!`
+
+All storefront configuration for the project
+
 #### `cartDisplayPricesInclTax: Boolean`
 
 Due to a limitation of the GraphQL API it is not possible to determine if a cart should be displayed including or excluding tax.
@@ -221,9 +221,9 @@ Issues that this can cause are:
 - The same package is included multiple times in the bundle, increasing the bundle size.
 - The Typescript types of the package are not compatible with each other, causing Typescript errors.
 
-### GraphCommerceI18nConfig
+### GraphCommerceStorefrontConfig
 
-All i18n configuration for the project
+All storefront configuration for the project
 
 #### `locale: String!`
 

package/framework/translations.md

@@ -139,9 +139,10 @@ msgstr "Cart ({0})"
    `Admin > Store > Configuration > General > General > Locale`. Choose one of
    the options from the Magento Locale codes (below).
 2. In your graphcommerce.config.js file, add the desired `locale` and
-   `magentoStoreCode` to the [i18n config](./config.md#graphcommercei18nconfig)
-   environment variable. The route will be visible to the user (added to the
-   url) when the user switches storeview.
+   `magentoStoreCode` to the
+   [i18n config](./config.md#GraphCommerceStorefrontConfig) environment
+   variable. The route will be visible to the user (added to the url) when the
+   user switches storeview.
 
    It's considered best practice to match the route with the store code,
    replacing an underscore for a dash. For example, to add Swedish (Finland),

package/package.json

@@ -2,10 +2,10 @@
   "name": "@graphcommerce/docs",
   "homepage": "https://www.graphcommerce.org/docs",
   "repository": "github:graphcommerce-org/graphcommerce/docs",
-  "version": "6.0.0-canary.43",
+  "version": "6.0.0-canary.45",
   "sideEffects": true,
   "devDependencies": {
-    "@graphcommerce/prettier-config-pwa": "6.0.0-canary.43"
+    "@graphcommerce/prettier-config-pwa": "6.0.0-canary.45"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }