The official monorepo for libraries implementing the Spark Design System, intended for use in Prenda applications. Spark libraries include customized Material-UI components and Prenda illustrations and icons.
Prenda Spark is available as an NPM package.
npm install @prenda/sparkhere is a quick example to get you started.
import * as React from 'react';
import ReactDOM from 'react-dom';
import { SparkThemeProvider, Button } from '@prenda/spark';
function App() {
return (
<SparkThemeProvider>
<Button>Hello World</Button>
</SparkThemeProvider>
);
}
ReactDOM.render(<App />, document.querySelector('#app'));The SparkThemeProvider can be placed anywhere in the render tree, at least above a Spark component (the need for the theme provider may be removed in the future).
There is no documentation site currently. We are working on getting a static storybook site up with self-documenting component stories.
Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Prenda Spark.
If you have recently updated, please read the changelog for each library for details of what has changed.
This project is licensed under the terms of the MIT license.
This project was generated using Nx. This project was formerly generated using Create React App and TSdx.
Prenda Spark is designed using Figma application, but is not affiliated with Figma in any way.