Inkwell UI React

Installation

npm i @aiinkwell/inkwell-ui-react

Quick Start

Option 1: Use InkwellProvider

Wrap your app with InkwellProvider to automatically apply the Aura theme to all components:

import React from 'react';
import ReactDOM from 'react-dom/client';
import { InkwellProvider, Button, Card } from '@aiinkwell/inkwell-ui-react';

function App() {
  return (
    <InkwellProvider>
      <Card header="Welcome">
        <Button>Click me</Button>
      </Card>
    </InkwellProvider>
  );
}

ReactDOM.createRoot(document.getElementById('root')).render(
  <React.StrictMode>
    <App />
  </React.StrictMode>
);

Option 2: Manual Setup (Advanced)

If you prefer to set up the theme manually:

import React from 'react';
import ReactDOM from 'react-dom/client';
import { InkwellProvider } from '@aiinkwell/inkwell-ui-react';
import Aura from '@primeuix/themes/aura';

const theme = {
  preset: Aura, // You can use different themes here
};

function App() {
  return (
    <InkwellProvider theme={theme}>{/* Your app content */}</InkwellProvider>
  );
}

ReactDOM.createRoot(document.getElementById('root')).render(
  <React.StrictMode>
    <App />
  </React.StrictMode>
);

Peer Dependencies

This package requires the following peer dependencies:

{
  "primereact": "^11.0.0",
  "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
  "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0"
}

Included Dependencies

The following dependencies are included in this package:

• @primeuix/themes - PrimeReact 11 theme system
• @primereact/core - PrimeReact 11 core
• @primereact/icons - PrimeReact 11 icons
• inkwell-ui-react-v10 - PrimeReact v10 components

Publishing a new version

1. Complete your changes inside library components/patterns
2. Run

  npm build

3. Next step - update version inside package.json file.

1.0.0 -> 2.0.0 - Major update 1.0.0 -> 1.1.0 - Minor update 1.0.0 -> 1.0.1 - Bugfix

4. Last step - you need to run command

  npm publish

And a new version of library will be updated

Browser Support

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Edge (latest)

License

MIT