mParticle Component Library built on top of Ant Design.
Components That Scale
| Dependency | Version | Notes |
|---|---|---|
| React | >=17.0.2 |
React 17 or 18 |
| React DOM | >=17.0.2 |
Must match React version |
| Node.js | >=24.12.0 |
For development |
yarn add @mparticle/aquarium antd@5 dayjs@1Or with npm:
npm install @mparticle/aquarium antd@5 dayjs@1Add the CSS reset to your app entry point (_app.tsx, layout.tsx, or index.tsx):
import 'antd/dist/reset.css'import { Button, Space, Typography } from '@mparticle/aquarium'
import { PaddingSm } from '@mparticle/aquarium/dist/style'
export const MyComponent = () => {
return (
<Space direction="vertical">
<Typography.Title level={3}>Hello Aquarium</Typography.Title>
<Typography.Text>Successfully installed!</Typography.Text>
<Space>
<Button type="primary" style={{ paddingLeft: PaddingSm }}>
Primary
</Button>
<Button>Default</Button>
</Space>
</Space>
)
}Clone the repository and install dependencies:
git clone [email protected]:mParticle/aquarium.git
cd aquarium
npm installRun Storybook for local development:
npm run storybookRun unit tests:
npm run test-storybookSee CONTRIBUTING.md.
Please make sure any new or updated components are present, tested and verified within Storybook.
mParticle's Aquarium is available under the Apache License, Version 2.0. See the LICENSE file for more info.