chayns-hooks
Advanced tools
Makes the chayns-js API easier to consume in your react components.
yarn add chayns-hooks
or
npm install chayns-hooks
Please note that this needs the chayns-js API to be available on the window object and chayns.ready should be finished.
The instructions for how to get started with the chayns-js API can be found here.
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Give a ⭐️ if this project helped you!
Copyright © 2020 Leo Driesch.
This project is MIT licensed.
Ƭ PossiblyEmptyString: string
Ƭ VisibilityEffect: function
A function that can respond to the change of the visibility status of your page.
param This parameter expresses wether the last visibility status update
indicates that the page is now shown or not.
▸ (isShown: boolean): void
Parameters:
| Name | Type |
|---|---|
isShown | boolean |
▸ useAdminMode(): AdminModeHookReturnValue
Using this hook will subscribe your component to the current state of the admin mode.
Returns: AdminModeHookReturnValue
An object that can be destructed to get access to the current status of the admin mode and functions to manually activate or deactivate the admin mode.
▸ useChaynsUser(): ChaynsUser
Returns the current user object and will update the user on access token change.
Returns: ChaynsUser
The user object for the currently logged in user.
▸ useVisibilityEffect(effect: VisibilityEffect): void
This hook can execute side effects when the visibility status of your page changes.
Parameters:
| Name | Type | Description |
|---|---|---|
effect | VisibilityEffect | This function will be called when the visibility changes and can respond to the change by executing side effects. Consider using useCallback with this function, otherwise the listener will be attached and detached on every render. |
Returns: void
Nothing. Use it similarly to useEffect.
• activateAdminMode: function
Calling this function will activate the admin mode, if it is currently inactive. Otherwise it will do nothing.
▸ (): void
• deactivateAdminMode: function
Calling this function will deactivate the admin mode, if it is active. Otherwise it will do nothing.
▸ (): void
• isAdminMode: boolean
Indicates if the user is currently in admin mode or not.
• adminMode: boolean
Wether the admin mode is currently active or not. Be careful with this, as
it might be stale. Use the useAdminMode hook when you need access to this
information.
Optional firstName• firstName? : undefined | string
• groups: UACGroup[]
This contains the groups for a user. Will be an empty array if the user is not logged in.
• id: number
The user-id.for the currently logged in user. Careful: If no user is logged
in, this will be 0 (not null or undefined)
• isAdmin: boolean
• isAuthenticated: boolean
Optional lastName• lastName? : undefined | string
• name: PossiblyEmptyString
The name for the currently logged in user. Careful: If no user is logged in, this value will be an empty string.
• personId: PossiblyEmptyString
The person-id for the currently logged in user. Careful: If no user is logged in, this value will be an empty string.
• tobitAccessToken: PossiblyEmptyString
The access token for the currently logged in user. Careful: If no user is logged in, the value will be an empty string.
• id: number
• isActive: boolean
Optional isSystemGroup• isSystemGroup? : undefined | false | true
Optional name• name? : undefined | string
FAQs
Makes the chayns-js API easier to consume in your react components.
The npm package chayns-hooks receives a total of 0 weekly downloads. As such, chayns-hooks popularity was classified as not popular.
We found that chayns-hooks demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.