React bindings for Keen IO SDK
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
assets
examples
src
.babelrc
.eslintrc
.gitignore
.npmignore
LICENSE
README.md
package-lock.json
package.json
yarn.lock

README.md

Keen Logo React Logo

React Keen

React components for Keen IO

Installation

npm install react-keen
# or
yarn add react-keen

Usage

Use Query and Chart components to create a chart of data from Keen. Query expects a client prop and parameters used by the Keen.Query of keen-analysis.js and Chart expects a data prop of the response from the query (a Keen.Dataset object) or a raw object and values passed to Keen.Dataviz methods. Check the examples/ directory for some examples

import Keen from 'keen-analysis'
import { Query, Chart } from 'react-keen'
import 'keen-dataviz/dist/keen-dataviz.css'

const client = new Keen({
    readKey: KEEN_READ_KEY
})

<Query
    client={client}
    event_collection='pageviews'
    timeframe='this_14_days'
>{data => (
    <Chart type="area" data={data} />
)}</Query>

Development

  • Clone the repo git clone git@github.com:iddan/react-keen.git
  • Install dependencies yarn install
  • Go to the examples directories cd examples/
  • Install examples dependencies yarn install
  • Run examples development server yarn start

Prior Art

License

MIT License