Skip to content

Commit

Permalink
feat(build): static and themeable production builds
Browse files Browse the repository at this point in the history
basic build

split the config

move some things around

unscoped build working

config changes

more config

oops

minor config changes

naming is hard

change compiled classname and remove some implicit deps

lockfile

address pr comments

slight restructure

add a build step to the travis config

duh, it's already a prepublishOnly step

remove references to config dir

dependency cleanup

remove eslint dep changes (will do this in separate PR)
  • Loading branch information
arizzitano committed Dec 21, 2017
1 parent f9221d9 commit 9d45e22
Show file tree
Hide file tree
Showing 9 changed files with 1,959 additions and 2,727 deletions.
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
coverage/*
dist
node_modules
static
themeable
8 changes: 6 additions & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": ["eslint-config-airbnb", "eslint-config-edx"],
"extends": ["eslint-config-edx"],
"parserOptions": {
"ecmaFeatures": {
"jsx": true
Expand All @@ -9,7 +9,11 @@
"react/no-array-index-key": "off"
},
"settings": {
"import/resolver": "webpack"
"import/resolver": {
"node": {
"extensions": [".js", ".jsx"]
}
}
},
"env": {
"jest": true
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ node_modules
npm-debug.log
coverage
jest*
static
themeable
2 changes: 1 addition & 1 deletion .storybook/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ module.exports = {
loader: 'css-loader',
options: {
modules: true,
localIdentName: '[name]__[local]___[hash:base64:5]',
localIdentName: '[local]',
sourceMap: true,
},
},
Expand Down
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,34 @@ Paragon provides accessible React components for use within the Open edX platfor

Components' markup, keyboard triggers, and behavior are based on the [WAI-ARIA 1.1 Authoring Practices](https://www.w3.org/TR/wai-aria-practices-1.1/). Components are styled with [Bootstrap 4](https://v4-alpha.getbootstrap.com/) via CSS Modules. Documentation/demo site is available at http://edx.github.io/paragon.

## Usage

Paragon requires React 16 or higher. To install Paragon into your project:

```
npm i --save @edx/paragon
```

Since Paragon is a React library, components must be rendered with React and ReactDOM. This doesn't mean the entire page has to be rendered with React. You can read up about rendering React into a page within the [official ReactDOM documentation](https://reactjs.org/docs/react-dom.html).

### Component API

API documentation for each component is available below:

- (asInput)[src/asInput]
- (Button)[src/Button]
- (CheckBox)[src/CheckBox]
- (Dropdown)[src/Dropdown]
- (Hyperlink)[src/Hyperlink]
- (InputSelect)[src/InputSelect]
- (InputText)[src/InputText]
- (Modal)[src/Modal]
- (RadioButtonGroup)[src/RadioButtonGroup]
- (StatusAlert)[src/StatusAlert]
- (Table)[src/Table]
- (Tabs)[src/Tabs]
- (TextArea)[src/TextArea]

## Development

First, clone the repo and install dependencies. You must be running Node 6 or newer.
Expand Down
Loading

0 comments on commit 9d45e22

Please sign in to comment.