icerockdev-admin-toolkit
Advanced tools
This is a tool for building admin panels, that can be installed as npm dependency.
This is a tool for building admin panels, that can be installed as npm dependency.
yarn add icerockdev-admin-toolkit
or
npm i -S icerockdev-admin-toolkit
import React from 'react';
import { Application } from 'admin-toolkit';
import config from './config';
export const App = () => <Application config={config} />;
The app is built on extendable classes. You can write your own autherntification by extending AuthProvider class. Creating complex pages should be made by extending Page class.
const config = new Config({
logo: '', // logo url
auth: new AuthProvider(authProviderOptions),
pages: [new Page(pageOptions), new Entity(entityOptions)],
theme, // custom theme options (see below)
});
AuthProvider is extendable class. You can override its metods for your needs. The app decides user authentication status by checking its token field, but you can override this behaviour in your own class, like this done in JWTAuthProvider.
new AuthProvider({
authRequestFn: (email, password) =>
Promise.resolve({
user: {
email: 'user@example.com',
username: 'username',
token: 'SAMPLE_TOKEN',
role: 'user',
},
error: '',
}),
authPasswRestoreFn: (email) =>
Promise.resolve({
error: '',
}),
persist: true, //store beetween sessions
});
JWTAuthProvider is extension of AuthProvider, but it has tokenRefreshFn to fetch renewed access token, using refresh token. Also, authRequestFn returns tokens field with access and refresh token pair:
new AuthProvider({
authRequestFn: (email, password) => (
Promise.resolve({
user: {
email: 'user@example.com',
username: 'username',
role: 'user'
},
tokens: {
access: 'accessToken',
refresh: 'refreshToken',
},
error: ''
})
),
authPasswRestoreFn: (email) => (
Promise.resolve({
error: '',
})
),
tokenRefreshFn: (refresh) => (
Promise.resolve({
access: 'newAccessToken',
refresh: 'newRefreshToken',
}),
),
persist: true, //store beetween sessions
});
auth.user - current user infoauth.withToken: (req, args) => Promise<any> - wrapper for callbacks, which used to add token value to function argumentsaurh.logout: () => void - function to log user outauth.isLogged: boolean - computed field to decide if user is logged inPage class is for rendering pages inside the app. You can extend it to create more complex pages, like this done in Entity class.
new Page({
title: 'Sample page',
menu: {
enabled: true,
url: '/test',
label: 'Sample page',
},
roles: {
// who can access this page
list: ['admin', 'manager'],
},
});
page.canList: boolean - if page can be viewed by current userpage.onMount: (page: Page) => void - method, called on mountpage.onUnmount: (page: Page) => void - method, called before unmountpage.output: ReactElement - react component, that renders page contentJust extend Page class and add your functionality. Override output, onMount, onUnmount methods to create your own content behaviour.
Entity is used to display list of some database entities, view their details and edit them. The Entity class extends Page one.
new Entity({
...pageOptions,
title: 'Sample entity',
editable: true,
viewable: true,
creatable: true,
exportable: true,
api: {
get: { url: '/get', method: 'get' },
list: { url: '/list', method: 'get' },
update: { url: '/update', method: 'patch' },
create: { url: '/create', method: 'post' },
},
menu: {
enabled: true,
label: 'Sample entity',
url: '/entity',
},
references: {
status: {
getMany: async () => {
return {
1: 'variant 1',
2: 'variant 2',
};
},
},
},
fields: [
{
name: 'type',
label: 'Тип',
sortable: true,
type: 'custom', // see Fields below
component: EntityTypeField,
},
{
name: 'status',
label: 'Статус',
sortable: true,
filterable: true,
type: 'referenceSelect',
required: true,
},
],
getItemsFn, // see getItemsFn below
fetchItemsFn, // see fetchItemsFn below
updateItemsFn, // see updateItemsFn below
createItemsFn, // see createItemsFn below
});
(extends Page methods and values)
entity.canView: boolean - if entity can be viewed by current userentity.canEdit: boolean - if entity can be edited by current userentity.canCreate: boolean - if entity can be created by current userentity.output - component, that renders entity page and contains router for list, view, edit and create pagesentity.List, entity.Viewer, entity.Editor, entity.Creator - overridable components for viewing, editing and creating itementity.ListHead, entity.ListBody, entity.ListFooter - overridable parts of entity.List componententity.EditorHead, entity.EditorBody, entity.EditorFooter - overridable parts of entity.Editor componententity.ViewerHead, entity.ViewerHeadButtons, entity.ViewerBody, entity.ViewerFooter - overridable parts of entity.Viewer componententity.ListExtra - if not null, renders entity list as accordeons, expanding by click with ListExtra's component as accordeon contententity.CreatorHead, entity.CreatorHeadButtons, entity.CreatorBody, entity.CreatorFooter - overridable parts of entity.Creator componententity.isLoading: boolean - is item currently loading / updatingentity.items: number - how many items per page should be displayed in view listentity.itemsPerPage: number[] - available options for itemsentity.page: number - current pageentity.exportData - used to export data in preferred format (currently .csv)entity.setFiltersWindowHash, getFiltersFromHash - syncing filters with page url using url hashEntity.fields is an array of objects. Every field can has following types: string, date, boolean, select, phone, richtext, base64image. custom or referenceSelect.
Every field is rendered by predefined or custom component, which accepts common options. isEditing prop tells component to render in view (when it's in a table or in entity preview) or editor (when it's in editor or acting as filter field).
name: string, - field name is it comes from the apilabel?: string, - field label (or name will be used)title?: true, - is this a title for entitytype: string - field typesortable?: boolean; - can we sort by this fieldfilterable?: boolean; - can we filter by this fieldrequired?: boolean; - is this field required. Used for basic validationvalidator?: (val: any) => boolean; - custom validatoroptions?: Record<any, any>; - options, passed for custom component or { [value]: key } for select componentcomponent?: FC<any>; - React Component to render field. Only for custom fieldshideInList?: boolean; - do not render in table of entitieshideInEdit?: boolean; - do not render in editor formhideInCreate?: boolean; - do not render in creator formhideInExport?: boolean; - do not export field in CSV {
name: "type",
label: "Тип",
sortable: true,
type: "custom",
component: EntityTypeField,
}
Custom fields are rendered by React Component specified in component prop. Custom field component options are:
value: any - field value for current componenthandler: (value: any) => void - function, that changes valuelabel: string - human readable labelerror: string - error (if any)isEditing: boolean - view or edit modeoptions: Record<any, any> - optionsdata: Record<string, any> - values for all the fields of current Entityfields: EntityField[] - description of all fieldswithToken: (req, args) => Promise<any> - function, that wraps requests with current user credentials (see AuthProvider) {
name: 'status',
label: 'Статус',
sortable: true,
filterable: true,
type: 'referenceSelect',
required: true,
},
The Entity should has references to fetch data, that will match reference fields data:
references: {
status: { // name should match the one in fields
getMany: async () => {
return {
1: 'variant 1',
2: 'variant 2',
3: 'variant 3',
};
},
},
},
getItemsFn - fetches entity by id.
type IEntityGetFunction = ({
url: string;
token?: string;
id: any;
}) => Promise<{
data: Record<string, any>;
error?: string
}>
fetchItemsFn - fetches entities list.
type IEntityFetchFunction = ({
url: string;
page?: number;
filter?: { name?: string; value?: any };
sortBy: string;
sortDir: string; // 'ASC' or 'DESC'
count?: number;
token?: string;
}) => Promise<{
data: {
list: Record<string, any>[];
totalCount?: number;
};
error?: string;
}>
updateItemsFn - updates entity after editing.
type IEntityUpdateFunction = ({
url: string;
id: any;
token?: string;
data: Record<string, any>;
}) => Promise<{
data: Record<string, any>; // updated data
error?: string;
}>
createItemsFn - creates new entity.
type IEntityCreateFunction = ({
url: string;
token?: string;
data: Record<string, any>;
}) => Promise<{
data: Record<string, any>; // updated data
error?: string;
}>
Throwing UNAUTHORIZED error will cause AuthProvider/JWTAuthProvider token update or logout, depending on result.
Each entity has a link to config via this.parent. You can access tokens by hitting this.parent.auth, but you'd better use this.parent.auth.withToken(fn, args) in your own entity methods.
withToken will add token arg to list of fn arguments, so you can pass it as auth header.
See https://material-ui.com/customization/theming/. To change colors, fonts, spacing, create your own theme and add it to config as theme prop:
import { createMuiTheme } from '@material-ui/core/styles';
export default createMuiTheme({
palette: {
primary: {
main: '#d20c0a',
},
},
typography: {
fontFamily: '"Roboto", "Helvetica", "Arial", "sans-serif"',
},
});
Use npm login or yarn login and then npm publish or yarn publish.
Don't forget to increase package version each time you commit changes.
Copyright 2020 IceRock MAG Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
FAQs
This is a tool for building admin panels, that can be installed as npm dependency.
The npm package icerockdev-admin-toolkit receives a total of 13 weekly downloads. As such, icerockdev-admin-toolkit popularity was classified as not popular.
We found that icerockdev-admin-toolkit demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.