README

jp-viaducto-components

status

Installation

  npm install @jp-olvera/jp-viaducto-components

Use

In order to use our components you need to wrap your application with our ConfigProvider.

import React from 'react';
import ReactDOM from 'react-dom';
import { ConfigProvider } from '@jp-olvera/jp-viaducto-components';

import App from './App';

ReactDOM.render(
  <React.StrictMode>
    <ConfigProvider>
      <App />
    </ConfigProvider>
  </React.StrictMode>,
  document.getElementById('app')
);

Overwrite configurations

Through our ConfigContext, you can get access to the default configurations and to the updateConfig function. You can find all the available configurations here

Note: There are configurations that are objects, if you want to overwrite some the keys, you need to provide the rest of them, for example iy you want to overwrite the xs breakpoint, you also need to provide the sm,md,lg andxl breakpoints, check the example below.

import React, { useContext, useEffect } from 'react';
import { ConfigContext } from '@jp-olvera/jp-viaducto-components';

const App = () => {
  const { updateConfig } = useContext(ConfigContext);

  const myConfig = {
    breakpoints: {
      xs: '20rem', //'320px'
      sm: '36rem', //'576px'
      md: '48rem', //'768px'
      lg: '62rem', //'992px'
      xl: '90rem', //'1440px'
      //... or any sizes
    },
  };
  useEffect(() => {
    updateConfig(myConfig);
  }, [myConfig]);

  return <div></div>;
};

Storybook

Find all about our components in the Storybook Project

Modal

The active and inactive states must be managed manually, you should provide the active state and a function to mutate it handleActive. By default the modal will call the handleActive after someone clicks on the overlay, unless you set the allowClickOutside property to false.

...
import { ConfigProvider, Modal } from '@jp-olvera/jp-viaducto-components';

export const SomeComponent = () => {
  const [active, setActive] = useState(false);
  const handleActive = () => {
    setActive(!active);
  }
  return (
    <Modal active handleActive = {handleActive}>
      {% Your modal content %}
    </Modal>
  )
}

Table

As a design system we are not providing extra functionality in the tables like filtering and ordering, although you can use our WrapperTable component to wrap your table, and add that extra functionality you want with React Table.

You can use our WrapperTable with the hooks provided by React Table because both are meant to use with semantic HTML.


import { WrapperTable } from '@jp-olvera/jp-viaducto-components';

const Component () => (
  <WrapperTable>
    <table>
      <tbody>
        <tr>
          <th scope="col">Header 1</th>
          <th scope="col">Header 2</th>
        </tr>
        <tr>
          <td>Data 1</td>
          <td>Data 2</td>
        </tr>
      </tbody>
    </table>
  </WrapperTable>
);

Usage no npm install needed!