@appello/web-kit

Web frontend library of components and modules

This library is for web reusable code only, do not add related to mobile modules. If you need to use something from this library for mobile development - you should move it to the @appello/common package. If your module/component became usable for mobile too you need to move it also.

How to use

Download package from npm:

npm i @appello/web-kit

Import modules you need in your code:

import { useSearchParams } from '@appello/web-kit';

Hooks

1. useBlobObjectUrl - convert blob file to url object
2. useClickAway - handle for click outside node
3. useListQueryParams - special hook for save pagination in query params
4. useSearchParams - get params from url
5. useCopyToClipboard - copy text to clipboard

Development guide

For developers

Note that we have a clear hierarchy in repo and if you have a 'developer' role - you can not merge directly, you have to create merge request and assign it to one of maintainers!!.

Before you start, don't forget to switch the directory you want to work in. Then run 'npm i' in this directory.

If you are creating a new module/function/component etc., do not forget to make export in index.ts of its folder:

export * from './useSearchParams';

If you need to create new module, do not forget to add index.ts with exports.

!!! Do not change config files if you don't have clear explanation why you want to do it. In case you have, please contact any maintainer, otherwise it would be rejected. !!!

For maintainers

It is required to change version before publish:

go to package folder and run npm version [<newversion> | major | minor | patch ]

For more information about versioning visit https://docs.npmjs.com/cli/v7/commands/npm-version

The next step is just publish new version:

npm publish

IMPORTANT!! Don't forget to push&merge into git repo to keep it up-to-date.