ST-UI-Toolkit
React Component Toolkit for Social Tables.
Website & Documentation: http://socialtables.github.io/ST-UI-Toolkit
Status
V2
Version 2.x requires React 16.8 at minimum. For React 15 please use version 1.x.
Getting Started
ST-UI-Toolkit is available as a public npm package. Once you have npm you can install ST-UI-Toolkit in your project folder with:
npm install @socialtables/st-ui-toolkit
Import & Use Components
We recommend you get started with React first. Once you have a simple application setup you can import any component and use it right away. No stylesheets, font or any other prerequisite needed.
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
</head>
<body>
<div id="react-root"></div>
<!--
You can use browserify, webpack or similar tools
to compile & combine your JSX code
-->
<script src="bundle.js"></script>
</body>
</html>
const React = require('react');
const ReactDOM = require('react-dom');
const STUIToolkit = require('@socialtables/st-ui-toolkit');
const Button = STUIToolkit.Button;
class App extends React.Component {
_clickHandler() {
alert("YOLO");
}
render() {
return <div>
<Button onClick={this._clickHandler} />
</div>;
}
}
ReactDOM.render(<App/>, document.getElementById('react-root'));
Learn more
In addition you can dig through the documentation to learn about how to add and use components.
Browser Support
- Chrome (mobile and desktop)
- Safari (mobile and desktop)
- Firefox
- Internet Explorer 9, 10, 11
Philosophy
As we design the User Interfaces for various products here at Social Tables, we often times run into common patters or components that we end up re-implementing in multiple places. This library allows us to place all of our reusable patterns into a single module that can be used by any Social Table's application.
Development
You can install the development environment with
npm install
npm run build will trigger a build into the lib folder.
Run the examples or docs application
To run the examples/docs run npm run storybook.
As you update the storybook for the docs or the components, the changes will update in real-time within the browser.
Tests
In order to run the tests use
npm test
To run the test continuously you can use npm run test:watch.
Future Plans
Special Thanks
License
Copyright (C) 2017 Social Tables, Inc. (https://www.socialtables.com) All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
