## Installation
`Lupa` is on NPM so install using your preferred JS package manager.
```bash
yarn add @lupa/excel @lupa/lupa
npm install @lupa/excel @lupa/lupa
```
## Usage
In order for the `` component to load, you need to have [Office.js][1] loaded. The easiest way to load [Office.js][1] is to include the following script tag in your page header
```html
```
With [Office.js][1] loaded, wrap the top level of your React app in the `` component;
```jsx
import { ExcelDataset } from '@lupa/excel';
export default function App() {
return (
The rest of my app
)
}
```
Now in any of the components underneath `` you can use the various hooks from `@lupa/lupa`;
```jsx
import React from 'react';
import { useData, useFeatures, useShape } from '@lupa/lupa';
export default function LupaInfo() {
const data = useData();
const features = useFeatures();
const shape = useShape();
const onClick = React.useCallback(async () => {
// We know that `data` is an async function because we're inside
// Generic components should use `dataIsAsyncMethod` or `dataIsRowArray` from '@lupa/lupa'
const d = await data();
console.log(d);
}, [data]);
return (
Data
Shape
{shape}
Features
{features.map(f =>
{key}
)}
Data
)
}
```
[//]: # (Link References)
[1]: https://docs.microsoft.com/en-us/office/dev/add-ins/develop/understanding-the-javascript-api-for-office "OfficeJS"
---
_Source: https://npm.io/package/@lupa/excel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
