@teambit/react 0.0.566 → 0.0.570

package/templates/react-app/files/doc.ts

@@ -0,0 +1,29 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function docFile({ name }: ComponentContext) {
+  return `---
+description: Application.
+labels: ['env', 'app']
+---
+
+## Application component
+
+- The app file contains components from react router dom so you can add here all routes for your app and include all your page components.
+- The main runtime file contains what is needed to build your application as a React app.
+- The app root file renders your app to the DOM.
+- The compositions file renders your app so it can be seen in the compositions tab.
+- The aspect file contains the id of the aspect. You will need to modify this with your own org name, scope name and namespace if any, and then add it to your \`workspace.json\` file at root level like:
+
+\`\`\`json
+"org-name.scope-name/namespace/name": {},
+\`\`\`
+
+### Run the application
+
+You can run your application on a separate port to see it outside of the Bit workspace
+
+\`\`\`bash
+bit run ${name}
+\`\`\`
+`;
+}

package/templates/react-app/files/index.ts

@@ -0,0 +1,10 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function indexFile({ name, namePascalCase: Name }: ComponentContext) {
+  return `import { ${Name}Aspect } from './${name}.aspect';
+
+export type { ${Name}Main } from './${name}.main.runtime';
+export default ${Name}Aspect;
+export { ${Name}Aspect };
+`;
+}

package/templates/react-app/files/main.runtime.ts

@@ -0,0 +1,22 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function mainRuntimeFile({ name, namePascalCase: Name }: ComponentContext) {
+  return `import { MainRuntime } from '@teambit/cli';
+import { ReactAspect, ReactMain } from '@teambit/react';
+import { ${Name}Aspect } from './${name}.aspect';
+
+export class ${Name}Main {
+  static slots = [];
+  static dependencies = [ReactAspect];
+  static runtime = MainRuntime;
+  static async provider([react]: [ReactMain]) {
+    react.registerReactApp({
+      name: '${name}',
+      entry: ['dist/${name}.app-root']
+    });
+    return new ${Name}Main();
+  }
+}
+${Name}Aspect.addRuntime(${Name}Main);
+`;
+}

package/templates/react-app/index.ts

@@ -0,0 +1,47 @@
+import { ComponentContext, ComponentTemplate } from '@teambit/generator';
+import { indexFile } from './files/index';
+import { docFile } from './files/doc';
+import { mainRuntimeFile } from './files/main.runtime';
+import { compositionsFile } from './files/compositions';
+import { aspectFile } from './files/aspect';
+import { appFile } from './files/app';
+import { appRootFile } from './files/app-root';
+
+export const reactAppTemplate: ComponentTemplate = {
+  name: 'react-app',
+  hidden: true,
+  description: 'Creates a React app',
+  generateFiles: (context: ComponentContext) => {
+    return [
+      {
+        relativePath: 'index.ts',
+        content: indexFile(context),
+        isMain: true,
+      },
+      {
+        relativePath: `${context.name}.docs.mdx`,
+        content: docFile(context),
+      },
+      {
+        relativePath: `${context.name}.main.runtime.ts`,
+        content: mainRuntimeFile(context),
+      },
+      {
+        relativePath: `${context.name}.compositions.tsx`,
+        content: compositionsFile(context),
+      },
+      {
+        relativePath: `${context.name}.aspect.ts`,
+        content: aspectFile(context),
+      },
+      {
+        relativePath: `app.tsx`,
+        content: appFile(context),
+      },
+      {
+        relativePath: `${context.name}.app-root.tsx`,
+        content: appRootFile(context),
+      },
+    ];
+  },
+};

package/templates/react-component/files/component.ts

@@ -0,0 +1,25 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const componentFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+  return {
+    relativePath: `${name}.tsx`,
+    content: `import React from 'react';
+
+export type ${Name}Props = {
+  /**
+   * a text to be rendered in the component.
+   */
+  text: string
+};
+
+export function ${Name}({ text }: ${Name}Props) {
+  return (
+    <div>
+      {text}
+    </div>
+  );
+}
+`,
+  };
+};

package/templates/react-component/files/composition.ts

@@ -0,0 +1,16 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const compositionFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+
+  return {
+    relativePath: `${name}.composition.tsx`,
+    content: `import React from 'react';
+import { ${Name} } from './${name}';
+
+export const Basic${Name} = () => (
+  <${Name} text="hello from ${Name}" />
+);
+`,
+  };
+};

package/templates/react-component/files/docs.ts

@@ -0,0 +1,32 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const docsFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+
+  return {
+    relativePath: `${name}.docs.mdx`,
+    content: `---
+description: 'A ${Name} component.'
+labels: ['label1', 'label2', 'label3']
+---
+
+import { ${Name} } from './${name}';
+
+## React Component for rendering text
+
+A basic div that renders some text
+
+### Component usage
+\`\`\`js
+<${Name} text="hello from ${Name}" />
+\`\`\`
+
+### Using props to customize the text
+
+Modify the text to see it change live:
+\`\`\`js live
+<${Name} text="hello from ${Name}" />
+\`\`\`
+`,
+  };
+};

package/templates/react-component/files/test.ts

@@ -0,0 +1,19 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const testFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+
+  return {
+    relativePath: `${name}.spec.tsx`,
+    content: `import React from 'react';
+import { render } from '@testing-library/react';
+import { Basic${Name} } from './${name}.composition';
+
+it('should render with the correct text', () => {
+  const { getByText } = render(<Basic${Name} />);
+  const rendered = getByText('hello from ${Name}');
+  expect(rendered).toBeTruthy();
+});
+`,
+  };
+};

package/templates/react-component/index.ts

@@ -0,0 +1,40 @@
+import { ComponentTemplate, ComponentContext } from '@teambit/generator';
+import { componentFile } from './files/component';
+import { compositionFile } from './files/composition';
+import { docsFile } from './files/docs';
+import { testFile } from './files/test';
+
+export const reactComponent: ComponentTemplate = {
+  name: 'react',
+  description: 'a basic react component',
+
+  generateFiles: (context: ComponentContext) => {
+    const { name, namePascalCase: Name } = context;
+    const indexFile = {
+      relativePath: 'index.ts',
+      content: `export { ${Name} } from './${name}';
+export type { ${Name}Props } from './${name}';
+`,
+    };
+
+    return [indexFile, componentFile(context), compositionFile(context), docsFile(context), testFile(context)];
+  },
+};
+
+export const deprecatedReactComponent: ComponentTemplate = {
+  name: 'react-component',
+  description: 'a basic react component',
+  hidden: true,
+
+  generateFiles: (context: ComponentContext) => {
+    const { name, namePascalCase: Name } = context;
+    const indexFile = {
+      relativePath: 'index.ts',
+      content: `export { ${Name} } from './${name}';
+export type { ${Name}Props } from './${name}';
+`,
+    };
+
+    return [indexFile, componentFile(context), compositionFile(context), docsFile(context), testFile(context)];
+  },
+};

package/templates/react-component-js/files/component.ts

@@ -0,0 +1,18 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const componentFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+  return {
+    relativePath: `${name}.jsx`,
+    content: `import React from 'react';
+
+export function ${Name}({ text }) {
+  return (
+    <div>
+      {text}
+    </div>
+  );
+}
+`,
+  };
+};

package/templates/react-component-js/files/composition.ts

@@ -0,0 +1,16 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const compositionFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+
+  return {
+    relativePath: `${name}.composition.jsx`,
+    content: `import React from 'react';
+import { ${Name} } from './${name}';
+
+export const Basic${Name} = () => (
+  <${Name} text="hello from ${Name}" />
+);
+`,
+  };
+};

package/templates/react-component-js/files/docs.ts

@@ -0,0 +1,32 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const docsFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+
+  return {
+    relativePath: `${name}.docs.mdx`,
+    content: `---
+description: 'A ${Name} component.'
+labels: ['label1', 'label2', 'label3']
+---
+
+import { ${Name} } from './${name}';
+
+## React Component for rendering text
+
+A basic div that renders some text
+
+### Component usage
+\`\`\`js
+<${Name} text="hello from ${Name}" />
+\`\`\`
+
+### Using props to customize the text
+
+Modify the text to see it change live:
+\`\`\`js live
+<${Name} text="hello from ${Name}" />
+\`\`\`
+`,
+  };
+};

package/templates/react-component-js/files/test.ts

@@ -0,0 +1,21 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const testFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+
+  return {
+    relativePath: `${name}.spec.jsx`,
+    content: `import React from 'react';
+import { render } from '@testing-library/react';
+import { Basic${Name} } from './${name}.composition';
+
+
+it('should render with the correct text', () => {
+  const { getByText } = render(<Basic${Name} />);
+  const rendered = getByText('hello from ${Name}');
+  expect(rendered).toBeTruthy();
+});
+
+`,
+  };
+};

package/templates/react-component-js/index.ts

@@ -0,0 +1,38 @@
+import { ComponentTemplate, ComponentContext } from '@teambit/generator';
+import { componentFile } from './files/component';
+import { compositionFile } from './files/composition';
+import { docsFile } from './files/docs';
+import { testFile } from './files/test';
+
+export const reactComponentJS: ComponentTemplate = {
+  name: 'react-js',
+  description: 'a basic react component in js',
+
+  generateFiles: (context: ComponentContext) => {
+    const { name, namePascalCase: Name } = context;
+    const indexFile = {
+      relativePath: 'index.js',
+      content: `export { ${Name} } from './${name}';
+`,
+    };
+
+    return [indexFile, componentFile(context), compositionFile(context), docsFile(context), testFile(context)];
+  },
+};
+
+export const deprecatedReactComponentJS: ComponentTemplate = {
+  name: 'react-component-js',
+  description: 'a basic react component in js',
+  hidden: true,
+
+  generateFiles: (context: ComponentContext) => {
+    const { name, namePascalCase: Name } = context;
+    const indexFile = {
+      relativePath: 'index.js',
+      content: `export { ${Name} } from './${name}';
+`,
+    };
+
+    return [indexFile, componentFile(context), compositionFile(context), docsFile(context), testFile(context)];
+  },
+};

package/templates/react-context/files/composition.ts

@@ -0,0 +1,27 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const compositionFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+
+  return {
+    relativePath: `${name}-context.composition.tsx`,
+    content: `import React, { useContext } from 'react';
+import { ${Name}Provider } from './${name}-context-provider';
+import { ${Name}Context } from './${name}-context';
+
+export function MockComponent() {
+  const theme = useContext(${Name}Context);
+
+  return <div style={{ color: theme.color }}>this should be {theme.color}</div>;
+}
+
+export const BasicThemeUsage = () => {
+  return (
+    <${Name}Provider color="blue">
+      <MockComponent />
+    </${Name}Provider>
+  );
+};
+`,
+  };
+};

package/templates/react-context/files/context-provider.ts

@@ -0,0 +1,27 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const contextProviderFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+  return {
+    relativePath: `${name}-context-provider.tsx`,
+    content: `import React, { ReactNode } from 'react';
+import { ${Name}Context } from './${name}-context';
+
+export type ${Name}ProviderProps = {
+  /**
+   * primary color of theme.
+   */
+  color?: string,
+
+  /**
+   * children to be rendered within this theme.
+   */
+  children: ReactNode
+};
+
+export function ${Name}Provider({ color, children }: ${Name}ProviderProps) {
+  return <${Name}Context.Provider value={{ color }}>{children}</${Name}Context.Provider>
+}
+`,
+  };
+};

package/templates/react-context/files/context.ts

@@ -0,0 +1,21 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const contextFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+  return {
+    relativePath: `${name}-context.tsx`,
+    content: `import { createContext } from 'react';
+
+export type ${Name}ContextType = {
+  /**
+   * primary color of theme.
+   */
+  color?: string;
+};
+
+export const ${Name}Context = createContext<${Name}ContextType>({
+  color: 'aqua'
+});
+`,
+  };
+};

package/templates/react-context/files/docs.ts

@@ -0,0 +1,51 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const docsFile = (context: ComponentContext) => {
+  const { name, namePascalCase: Name } = context;
+
+  return {
+    relativePath: `${name}-context.docs.mdx`,
+    content: `---
+description: ${Name} context.
+labels: ['context']
+---
+
+import { ${Name}Context } from './${name}-context';
+import { ${Name}Provider } from './${name}-context-provider';
+import { MockComponent } from './${name}-context.composition';
+
+## React Theme Context
+
+This is a simple [React Context](https://reactjs.org/docs/context.html) shared as a Bit component.
+Use this component to apply a theme as a context to set on it's children.
+
+### Component usage
+
+\`\`\`tsx
+() => {
+import React, { useContext } from 'react';
+import { ThemeProvider } from './theme-context-provider';
+import { ThemeContext } from './theme-context';
+
+<${Name}Provider color="blue">
+  // My lovely children now get a theme!
+  <MockComponent />
+</${Name}Provider>;
+\`\`\`
+
+### Using props to customize the theme
+
+Change the color to see the text change:
+
+\`\`\`tsx live
+() => {
+  return (
+    <${Name}Provider color="red">
+      <MockComponent />
+    </${Name}Provider>
+  );
+};
+\`\`\`
+`,
+  };
+};

package/templates/react-context/files/test.ts

@@ -0,0 +1,18 @@
+import { ComponentContext } from '@teambit/generator';
+
+export const testFile = (context: ComponentContext) => {
+  const { name } = context;
+
+  return {
+    relativePath: `${name}-context.spec.tsx`,
+    content: `import { BasicThemeUsage } from './${name}-context.composition';
+import { render } from '@testing-library/react';
+
+it('should render the button in the color blue', () => {
+  const { getByText } = render(<BasicThemeUsage />);
+  const rendered = getByText('this should be blue');
+  expect(rendered).toBeTruthy();
+});
+`,
+  };
+};

package/templates/react-context/index.ts

@@ -0,0 +1,32 @@
+import { ComponentTemplate, ComponentContext } from '@teambit/generator';
+import { contextFile } from './files/context';
+import { contextProviderFile } from './files/context-provider';
+import { compositionFile } from './files/composition';
+import { docsFile } from './files/docs';
+import { testFile } from './files/test';
+
+export const reactContext: ComponentTemplate = {
+  name: 'react-context',
+  description: 'a react context component',
+
+  generateFiles: (context: ComponentContext) => {
+    const { name, namePascalCase: Name } = context;
+    const indexFile = {
+      relativePath: 'index.ts',
+      content: `export { ${Name}Context } from './${name}-context';
+export type { ${Name}ContextType } from './${name}-context';
+export { ${Name}Provider } from './${name}-context-provider';
+export type { ${Name}ProviderProps } from './${name}-context-provider';
+`,
+    };
+
+    return [
+      indexFile,
+      contextFile(context),
+      contextProviderFile(context),
+      compositionFile(context),
+      docsFile(context),
+      testFile(context),
+    ];
+  },
+};

package/templates/react-env/files/aspect.ts

@@ -0,0 +1,10 @@
+import { ComponentContext } from '@teambit/generator';
+
+export function aspectFile({ namePascalCase: Name, componentId }: ComponentContext) {
+  return `import { Aspect } from '@teambit/harmony';
+
+export const ${Name}Aspect = Aspect.create({
+  id: '${componentId}',
+});
+`;
+}