feat: improve documentation and clarity of react-components pkg (#60)

awslabs · Feb 16, 2022 · a1615f9 · a1615f9
1 parent 7b0f3cf
commit a1615f9
Show file tree

Hide file tree

Showing 11 changed files with 5 additions and 34 deletions.
diff --git a/packages/react-components/src/components.ts b/packages/react-components/src/components.ts
@@ -1,11 +1,13 @@
 /* eslint-disable */
 /* tslint:disable */
-import { createReactComponent } from './react-component-lib';
+import { createReactComponent } from './stencil-generated';
 
 import type { JSX } from '@iot-app-kit/components';
 
-
-
+/**
+ * Manually add each component that we would like to expose as part of the react-components library.
+ * This will be the final API of this library.
+ */
 export const BarChart = /*@__PURE__*/createReactComponent<JSX.IotBarChart, HTMLIotBarChartElement>('iot-bar-chart');
 export const Kpi = /*@__PURE__*/createReactComponent<JSX.IotKpi, HTMLIotKpiElement>('iot-kpi');
 export const LineChart = /*@__PURE__*/createReactComponent<JSX.IotLineChart, HTMLIotLineChartElement>('iot-line-chart');

diff --git a/packages/react-components/src/components/index.ts b/packages/react-components/src/components/index.ts
diff --git a/packages/react-components/src/components/stencil-generated/index.ts b/packages/react-components/src/components/stencil-generated/index.ts
diff --git a/...c/react-component-lib/createComponent.tsx → ...src/stencil-generated/createComponent.tsx b/...c/react-component-lib/createComponent.tsx → ...src/stencil-generated/createComponent.tsx
diff --git a/...-component-lib/createOverlayComponent.tsx → ...ncil-generated/createOverlayComponent.tsx b/...-component-lib/createOverlayComponent.tsx → ...ncil-generated/createOverlayComponent.tsx
diff --git a/...mponents/src/react-component-lib/index.ts → ...components/src/stencil-generated/index.ts b/...mponents/src/react-component-lib/index.ts → ...components/src/stencil-generated/index.ts
diff --git a/...nts/src/react-component-lib/interfaces.ts → ...nents/src/stencil-generated/interfaces.ts b/...nts/src/react-component-lib/interfaces.ts → ...nents/src/stencil-generated/interfaces.ts
diff --git a/.../react-component-lib/utils/attachProps.ts → ...rc/stencil-generated/utils/attachProps.ts b/.../react-component-lib/utils/attachProps.ts → ...rc/stencil-generated/utils/attachProps.ts
diff --git a/...nts/src/react-component-lib/utils/case.ts → ...nents/src/stencil-generated/utils/case.ts b/...nts/src/react-component-lib/utils/case.ts → ...nents/src/stencil-generated/utils/case.ts
diff --git a/...ents/src/react-component-lib/utils/dev.ts → ...onents/src/stencil-generated/utils/dev.ts b/...ents/src/react-component-lib/utils/dev.ts → ...onents/src/stencil-generated/utils/dev.ts
diff --git a/...s/src/react-component-lib/utils/index.tsx → ...nts/src/stencil-generated/utils/index.tsx b/...s/src/react-component-lib/utils/index.tsx → ...nts/src/stencil-generated/utils/index.tsx