@drfonix/new-component NPM

Create a new React component

Forked from https://www.npmjs.com/package/@metamn/new-component

Added configurable language files + separate style file for MUI support

Usage

Install via NPM:

# Using Yarn:
$ yarn global add @drfonix/new-component

# or, using NPM
$ npm i -g @drfonix/new-component

Run:

$ cd PROJECT_DIRECTORY
$ new-component Button -l en-nl
# or, using npx
$ npx new-component Button -l en-nl

Special edition

This version of new-component is a special edition supporting translations with i18next at component level.

Setup

You must have a i18n.js config file next to the index.js file in a CRA app.

import i18n from "i18next";
import { initReactI18next } from "react-i18next";
import LanguageDetector from "i18next-browser-languagedetector";

/**
 * Sets up translations
 *
 * - Every component manages it's own translations via namespaces
 * - Every component adds it's own translation items to `resources`
 *
 * @see https://github.com/i18next/react-i18next/issues/299
 * @see https://react.i18next.com/latest/usetranslation-hook#loading-namespaces
 *
 */
const resources = {};

/**
 * Sets up i18next
 *
 * @see https://react.i18next.com/latest/using-with-hooks
 */
i18n
  /**
   * Detects user language
   *
   * @see https://github.com/i18next/i18next-browser-languageDetector
   */
  .use(LanguageDetector)
  /**
   * Passes the i18n instance to react-i18next.
   */
  .use(initReactI18next)
  /**
   * Inits i18next
   *
   * @see https://www.i18next.com/overview/configuration-options
   */
  .init({
    resources,
    lng: "en-EN",

    keySeparator: false, // we do not use keys in form messages.welcome

    interpolation: {
      escapeValue: false // react already safes from xss
    }
  });

export default i18n;

In index.js you'll have to add this import statement:

import "./i18n"; // See https://react.i18next.com/latest/using-with-hooks

What you'll get

In src/components/Button:

// `Button/Button.js`
import React from "react";
import PropTypes from "prop-types";

/**
 * Imports styles
 */
import { useStyles } from "./Button.styles";

/**
 * Imports i18n
 */
import i18n from "../../i18n";
import { useTranslation } from "react-i18next";
import { en_en } from "./Button.lang.en-en";

i18n.addResourceBundle("en-EN", "Button", en_en);

/**
 * Defines the prop types
 */
const propTypes = {};

/**
 * Defines the default props
 */
const defaultProps = {};

/**
 * Displays the component
 */
const Button = props => {
  /**
   * Handles the translations
   */
  const { t } = useTranslation("Button");

  /**
   * Gets the component styles
   */
  const button = useStyles();
  
  return <div className={button}>{t("Button")}</div>;
};

Button.propTypes = propTypes;
Button.defaultProps = defaultProps;

export default Button;
export { propTypes as ButtonPropTypes, defaultProps as ButtonDefaultProps };

// `Button/Button.stories.js`
import React from "react";
import Button from "./Button";
import ApiDoc from "./Button.md";

export default {
  component: Button,
  title: "Button",
  parameters: { notes: ApiDoc }
};

export const Default = () => <Button />;

// `Button/Button.md`
# Button

// `Button/Button.styles.js`
/**
 *  Imports Material UI
 */
import { makeStyles } from "@material-ui/core";

/**
 * Styles the component
 */
const useStyles = makeStyles(theme => ({}));

export { useStyles };

// `Button/Button.test.js`
import React from "react";
import { render } from "@testing-library/react";
import Button from "./Button";

it("has a Button component", () => {
  const { getByText } = render(<Button />);
  expect(getByText("Button")).toBeInTheDocument();
});

// `Button/index.js`
export { default, ButtonPropTypes, ButtonDefaultProps } from "./Button";

// `Button/Button.lang.en-en.js`
const en_en = {
  Button: "Button"
};

export { en_en };

Modify & test locally

You can easily fork this repo, modify, test, and publish on npm.

NOTE: Always start with changing the version number in package.json !!

Test locally

In this current repo:

npm pack

This will create a file like new-component@0.0.1.tgz.

In another folder:

npm i <path_to_new_component_repo>/new-component@0.0.1.tgz &&
./node_modules/.bin/new-component Button

Update the changelog

NOTE: Always update the changelog

Publish

First push changes to Github. Then:

npm publish

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.3.3 - 2020-05-26

Fixed

Fix the component classes object. From =>

  ```
  const { button } = useStyle();
  ``` 
  To =>
  ```Javascript 
  const button = useStyle();
  ```

0.3.2 - 2020-05-19

Added

ComponentName.styles.js, added for easier material-ui implementation
configurable language command, because sometimes we need more specific languages.

Removed

styled-components, because many times components use another library, like material-ui

0.3.0 - 2020-01-14

Added

styled-components, re-added, because when a new component is added it's first purpose is to mockup. Also every new component has a border and padding added to serve mockuping.
react-i18next with addResourceBundle loading translations from language files co-located to the component