@evoke-platform/ui-components 1.1.0 → 1.2.0-dev.0

package/dist/published/stories/Introduction.stories.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export declare const Introduction: React.VFC<Record<string, never>>;
+declare const _default: {
+    title: string;
+    component: React.VFC<Record<string, never>>;
+};
+export default _default;

package/dist/published/stories/Introduction.stories.js

@@ -0,0 +1,50 @@
+import { Box, Container, Link, Typography } from '@mui/material';
+import React from 'react';
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const logo = require('../assets/evoke-logo.png');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const packageJson = require('../../package.json');
+const styles = {
+    header: { fontSize: '24px', fontWeight: 600 },
+    subheader: { paddingTop: '23px', fontSize: '16px', fontWeight: 600 },
+    code: { backgroundColor: '#f5f5f5', fontFamily: 'monospace' },
+};
+export const Introduction = () => (React.createElement(Container, null,
+    React.createElement(Box, { textAlign: "center", my: 4 },
+        React.createElement(Box, { sx: { padding: '20px' } },
+            React.createElement("img", { alt: "evoke-logo", height: "70", src: logo })),
+        React.createElement(Typography, { sx: styles.header }, "@evoke-platform/ui-components"),
+        React.createElement(Typography, { variant: "body1", mt: 2 }, "A collection of React components to use within custom widgets for the Evoke Platform."),
+        React.createElement(Typography, null,
+            "It is built on top of the",
+            ' ',
+            React.createElement(Link, { href: "https://mui.com/", rel: "noopener noreferrer", target: "_blank" }, "@mui/material"),
+            ' ',
+            "components."),
+        React.createElement(Box, { display: "flex", justifyContent: "center", gap: 2, my: 4 },
+            React.createElement(Typography, null,
+                "Version: ",
+                packageJson.version))),
+    React.createElement(Typography, { sx: styles.subheader }, "Installation"),
+    React.createElement(Typography, null,
+        "If your project was scaffolded using the plugin generator, then",
+        ' ',
+        React.createElement("strong", null, "@evoke-platform/ui-components"),
+        " is already available and no further installation is necessary."),
+    React.createElement(Box, { component: "pre", sx: { backgroundColor: '#f5f5f5', padding: 2, borderRadius: 1 } },
+        React.createElement(Typography, { sx: styles.code, component: "code" }, "npm i @evoke-platform/ui-components")),
+    React.createElement(Typography, { sx: styles.subheader }, "Usage"),
+    React.createElement(Typography, null, "Import the components you need from the package and use them in your application."),
+    React.createElement(Box, { component: "pre", sx: { backgroundColor: '#f5f5f5', padding: 2, borderRadius: 1 } },
+        React.createElement(Typography, { sx: styles.code, component: "code" },
+            `import { Button } from '@evoke-platform/ui-components';`,
+            `\n`,
+            `\nconst MyComponent = () => (`,
+            `\n    <Button variant="contained" color="primary">`,
+            `\n        Click Me`,
+            `\n    </Button>`,
+            `\n);`))));
+export default {
+    title: 'Introduction',
+    component: Introduction,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@evoke-platform/ui-components",
-    "version": "1.1.0",
+    "version": "1.2.0-dev.0",
     "description": "",
     "main": "dist/published/index.js",
     "module": "dist/published/index.js",