@appello/web-ui
v0.3.0
Published
Web ui library for a better development experience
Downloads
1,101
Readme
@appello/web-ui
React UI library of components and modules. Designed by Appello.
Installation
# using npm
npm install @appello/web-ui
# using pnpm
pnpm install @appello/web-ui
# using yarn
yarn add @appello/web-ui
IMPORTANT: These icons should be in src/view/assets/icons
: calendar.svg, down-arrow.svg, close.svg, magnifier.svg, bell.svg, polygon.svg, check.svg, eye.svg, eye-crossed.svg, document.svg
Basic usage
import '@appello/web-ui/dist/index.css';
import React from 'react';
import {
AppelloKit,
AppelloKitComponents,
AppelloKitComponentsProvider,
AppelloKitProvider,
} from '@appello/web-ui';
const defaultTheme: AppelloKit = {
pageSize: 10,
debounceDelay: 500,
dateFormat: 'dd/MM/yyyy',
};
const defaultComponentProps: AppelloKitComponents = {
PhotoField: {
photoPlaceholder: 'https://via.placeholder.com/150',
},
};
root.render(
<AppelloKitProvider value={defaultTheme}>
<AppelloKitComponentsProvider value={defaultComponentProps}>
<App />
</AppelloKitComponentsProvider>
</AppelloKitProvider>,
);
AppelloKit
interface
| Property | Type | Description |
| --------------- | ------ | ------------------------------------------------------------------- |
| pageSize
| number | The number of items to display per page |
| debounceDelay
| number | The delay time (in milliseconds) before triggering a search request |
| dateFormat
| string | The format for displaying dates within the application |