flamelink-react-hooks
Advanced tools
Readme
Some Flamelink SDK functionality exposed as React Hooks
npm install -S flamelink-react-hooks
flamelink-react-hooks uses the Flamelink SDK internally, so please take a look at the Installation & Usage sections for the SDK to see how you can instantiate the flamelinkApp instance.
import { createFlamelinkHooks } from 'flamelink-react-hooks'
import flamelink from 'flamelink/app'
import 'flamelink/content'
import 'flamelink/storage'
const flamelinkApp = flamelink(/* init flamelink app */)
const { useContent, useContentOnce } = createFlamelinkHooks({ flamelinkApp })
const YourComponent = function(props) {
const [error, content] = useContent({ schemaKey: 'homepage' })
if (error) {
return <p>Error Error Error</p>
}
return (
<section>
<h1>{content.title}</h1>
<p>{content.body}</p>
</section>
)
}
The following hooks are currently available
This hook sets up a real-time subscription for the content you want.
returns: [error, content]
Array with the first item an error object, otherwise it will be null and the second item will be the content payload - initially it will be null
This hook queries once for the content you want without setting up a real-time connection.
returns: [error, content]
Same as useContent
This hook sets up a real-time subscription for the navigation you want.
returns: [error, navigation]
Array with the first item an error object, otherwise it will be null and the second item will be the navigation payload - initially it will be null
This hook queries once for the navigation you want without setting up a real-time connection.
returns: [error, navigation]
Same as useNav
This hook sets up a real-time subscription for the users you want.
returns: [error, users]
Array with the first item an error object, otherwise it will be null and the second item will be the users payload - initially it will be null
This hook queries once for the users you want without setting up a real-time connection.
returns: [error, users]
Same as useUsers
Discover the release history by heading on over to the releases page.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Unless stated otherwise all works are:
and licensed under:
FAQs
Some Flamelink SDK functionality exposed as React Hooks
We found that flamelink-react-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
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.