Описание

Компонент базовой админки для использования в других проектах

Команды

• npm install — установка зависимостей
• npm build — сборка пакета

Обновление версии

Для обновления версии необходимо:

1. Поднять версию в package.json.
2. Прописать изменения в CHANGELOG.md.

Установка пакета в другие проекты

Для установки пакета выполните:

npm install isp-admin-ui-kit

Подключение базового стора

Импортируйте baseSetupStore и подключите store

Подключение темы

Базовое подключение темы с Ant Design встроено, при необходимости добавления динамических стилей для кастомных компонентов использовать переменные antd

Вызов базового стора

• В index.tsx обернуть компонент в Provider для корректной работы store
• Также необходим BrowserRouter для работы роутера

const store = baseSetupStore()
  
  <Provider store={store}>
    <BrowserRouter>
      <AdminBase />
    </BrowserRouter>
  </Provider>

Интеграция с кастомным стором

baseSetupStore принимает необязательный параметр apiServices

Название	Описание	Пример
apiServices	объект кастомных редьюсеров и слайсеров	const apiServices = { modulesServiceApi, UIReducer }

const store = baseSetupStore(apiServices)

Работаем с компонентом

Теперь вы можете импортировать компонент в свой проект, который имеет необязательные параметры:

Название	Описание	Пример
customRouters	массив объектов	customRouters={ [ { route?: string element?: any className?: string label: string key: string permissions: string[] icon?: any children?: [] } ] }
configProviderProps	объект, принимающий в себя пропсы для ConfigProvider из библиотеки antd в качестве ключей	configProviderProps={{theme: lightTheme, locale: eng}}

 <AdminBase/> 

или

 <AdminBase customRouters={[]} configProviderProps={{}}/>