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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ import React from 'react';
2
+ export declare const Introduction: React.VFC<Record<string, never>>;
3
+ declare const _default: {
4
+ title: string;
5
+ component: React.VFC<Record<string, never>>;
6
+ };
7
+ export default _default;
@@ -0,0 +1,50 @@
1
+ import { Box, Container, Link, Typography } from '@mui/material';
2
+ import React from 'react';
3
+ // eslint-disable-next-line @typescript-eslint/no-var-requires
4
+ const logo = require('../assets/evoke-logo.png');
5
+ // eslint-disable-next-line @typescript-eslint/no-var-requires
6
+ const packageJson = require('../../package.json');
7
+ const styles = {
8
+ header: { fontSize: '24px', fontWeight: 600 },
9
+ subheader: { paddingTop: '23px', fontSize: '16px', fontWeight: 600 },
10
+ code: { backgroundColor: '#f5f5f5', fontFamily: 'monospace' },
11
+ };
12
+ export const Introduction = () => (React.createElement(Container, null,
13
+ React.createElement(Box, { textAlign: "center", my: 4 },
14
+ React.createElement(Box, { sx: { padding: '20px' } },
15
+ React.createElement("img", { alt: "evoke-logo", height: "70", src: logo })),
16
+ React.createElement(Typography, { sx: styles.header }, "@evoke-platform/ui-components"),
17
+ React.createElement(Typography, { variant: "body1", mt: 2 }, "A collection of React components to use within custom widgets for the Evoke Platform."),
18
+ React.createElement(Typography, null,
19
+ "It is built on top of the",
20
+ ' ',
21
+ React.createElement(Link, { href: "https://mui.com/", rel: "noopener noreferrer", target: "_blank" }, "@mui/material"),
22
+ ' ',
23
+ "components."),
24
+ React.createElement(Box, { display: "flex", justifyContent: "center", gap: 2, my: 4 },
25
+ React.createElement(Typography, null,
26
+ "Version: ",
27
+ packageJson.version))),
28
+ React.createElement(Typography, { sx: styles.subheader }, "Installation"),
29
+ React.createElement(Typography, null,
30
+ "If your project was scaffolded using the plugin generator, then",
31
+ ' ',
32
+ React.createElement("strong", null, "@evoke-platform/ui-components"),
33
+ " is already available and no further installation is necessary."),
34
+ React.createElement(Box, { component: "pre", sx: { backgroundColor: '#f5f5f5', padding: 2, borderRadius: 1 } },
35
+ React.createElement(Typography, { sx: styles.code, component: "code" }, "npm i @evoke-platform/ui-components")),
36
+ React.createElement(Typography, { sx: styles.subheader }, "Usage"),
37
+ React.createElement(Typography, null, "Import the components you need from the package and use them in your application."),
38
+ React.createElement(Box, { component: "pre", sx: { backgroundColor: '#f5f5f5', padding: 2, borderRadius: 1 } },
39
+ React.createElement(Typography, { sx: styles.code, component: "code" },
40
+ `import { Button } from '@evoke-platform/ui-components';`,
41
+ `\n`,
42
+ `\nconst MyComponent = () => (`,
43
+ `\n <Button variant="contained" color="primary">`,
44
+ `\n Click Me`,
45
+ `\n </Button>`,
46
+ `\n);`))));
47
+ export default {
48
+ title: 'Introduction',
49
+ component: Introduction,
50
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@evoke-platform/ui-components",
3
- "version": "1.1.0",
3
+ "version": "1.2.0-dev.0",
4
4
  "description": "",
5
5
  "main": "dist/published/index.js",
6
6
  "module": "dist/published/index.js",