Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.62 KB

import-syntax.md

File metadata and controls

31 lines (20 loc) · 1.62 KB
Raw

Import Syntax

Option 1 - ES

If tree shaking is supported and properly configured in your build chain, you can use the following import syntax. Care must be taken to ensure that it is working properly, else this syntax will cause the entire library to be included in your bundle.

import { Button, Icon } from 'mineral-ui';

Option 2 - CommonJS

If your build chain does not support tree shaking, you should instead use the following import syntax.

import Button from ‘mineral-ui/Button’;
import Icon from ‘mineral-ui/Icon’;

In this scenario, the public API is defined as the items available in the top level index. Unless otherwise documented, anything else is considered private API and subject to change without notice.

It is important to note that some components may have particular import syntax requirements. Refer to the individual component documentation for details.

Plugins

There are several 3rd party plugins that allow you to write imports using the ES syntax described in option 1, without worrying about bundle size, and without yet having tree shaking working in your build chain. These may be useful as an interim step while you work towards the goal of adding tree shaking to your project.