@ag.ds-next/core - npm Package Compare versions

Comparing version 2.1.2 to 2.1.3

CHANGELOG.md

 # @ag.ds-next/core
 
+## 2.1.3
+
+### Patch Changes
+
+- e8ea2abe: Updated documentation
+
 ## 2.1.2
@@ -4,0 +10,0 @@

package.json

 {
 	"name": "@ag.ds-next/core",
-	"version": "2.1.2",
+	"version": "2.1.3",
 	"main": "dist/ag.ds-next-core.cjs.js",
@@ -5,0 +5,0 @@ "module": "dist/ag.ds-next-core.esm.js",

README.md

@@ -9,14 +9,34 @@ ---
 
-It accepts a `theme` prop that enables overwriting of the default theme.
+### Theming
 
+The `Core` component accepts a `theme` prop that enables overwriting of the default theme.
+
 ```jsx
 import { Core } from '@ag.ds-next/core';
 
-export const App = () => (
-	<Core theme={theme} linkComponent={LinkComponent}>
-		<MyApplication />
-	</Core>
-);
+export default function MyApp({ Component, pageProps }) {
+	return (
+		<Core theme={theme}>
+			<Component {...pageProps} />
+		</Core>
+	);
+}
 ```
 
+### Routing / Linking
+
+Our component library has been designed to work with any react routing library. For an example of configuring routing/links in AgDS for a Next.js application, please see [our example site](https://github.com/steelthreads/agds-next/tree/main/example-site/components/LinkComponent.tsx).
+
+```jsx
+import { Core } from '@ag.ds-next/core';
+
+export default function MyApp({ Component, pageProps }) {
+	return (
+		<Core theme={theme} linkComponent={LinkComponent}>
+			<Component {...pageProps} />
+		</Core>
+	);
+}
+```
+
 ## Design Tokens
@@ -23,0 +43,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

113544

increased by0.58%

Number of lines in readme file

152

increased by15.15%

No dependency changes