@ntragas/pouncejstest/README.md

A collection of UI components from Panther labs

# Pounce

🐯A Set of Composable React Primitives for Building UI Dashboards

[![CircleCI](https://circleci.com/gh/panther-labs/pounce/tree/master.svg?style=svg)](https://circleci.com/gh/panther-labs/pounce/tree/master)

## Description

This project contains common UI components for building dashboards written in TypeScript. It's currently used by [Panther](https://github.com/panther-labs/panther)

## Docs

Documentation is available on [http://pouncejs.surge.sh/](http://pouncejs.surge.sh/).

## Installation

Pounce heavily depends on Typescript and thus has a limitation of Typescript 3.8.x. Please make
sure that your project does't use an older version of Typescript.

```text
$ npm install pouncejs
```

## Usage

### Quick Start

1. To start, wrap your app with the `ThemeProvider` components:

```jsx
import { ThemeProvider } from 'pouncejs';

const App = () => (
    <ThemeProvider>
       <Router>
         ...
       </Router
    </ThemeProvider>
)
```

2. Install DM Sans:

```html
<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;700&display=swap"
/>
```

3.  Then you are ready to go!

```js
import { Box, Button } from 'pouncejs';
```

### Advanced

To use the library you'll need to wrap your app with the `<ThemeProvider>` so that your
components can have access to the theme. By default `<ThemeProvider>` utilises the default Theme
that Pounce exposes, but you can easily override that by passing a `theme` prop to it.

This can be done like so:

```jsx
import { ThemeProvider } from 'pouncejs';
import theme from '../my/theme.js';

const App = () => (
    <ThemeProvider theme={theme}>
       <Router>
         ...
       </Router
    </ThemeProvider>
)
```

Make sure to wrap your **entire** app with a `<ThemeProvider>` to avoid un-necessary reconsiliations
and to gain in performance.

The next step would be to make sure you have your selected font-family installed. By default,
Pounce uses `DM Sans` as it fits the default theme the best. If you are using the default theme,
make sure you install DM Sans in your prefered way. The easiest of them all is by adding
a link tag in your html:

```html
<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=DM+Sans:400,500,700&display=swap"
/>
```

If you want to use another font-family, simply install it and make sure to mimic this
change in the `theme` that you will provide to `<ThemeProvider />`. The change that
you need to make is in the `fonts.primary` key of the theme. For example:

```js
import { defaultTheme } from 'pouncejs';

export const myTheme = {
  ...defaultTheme,
  fonts: {
    ...defaultTheme.fonts,
    primary: 'Lato, sans-serif',
  },
};
```

This way you can keep all the defaults and only change the `font-family` exposed. You can also
add keys to the theme if you want to have a centralised theme configuration that can also be used
outside the context of pounce:

```js
import { defaultTheme } from 'pouncejs';

export const myTheme = {
  ...defaultTheme,
  fonts: {
    ...defaultTheme.fonts,
    secondary: 'Inconsolata, monospace',
  },
};
```

By default, pounce ships with dashboard-related icons, but you may add new ones by extending the
`icons` keyy of the theme. For example, if you want to add a new icon named `my-icon` you would
override the theme and pass it again to the `<ThemeProvider>` component.

```js
import { theme as defaultTheme } from 'pouncejs';

const myIcons = {
  'my-icon': {
    path: (
      <g id="collapse-table" stroke="none" fill="none">
        <rect x="0" y="0" width="24" height="24" />
      </g>
    ),
    viewBox: '0 0 24 24', // can be omitted if viewBox is `0 0 24 24` which is the default value
  },
};

const theme = {
  ...defaultTheme,
  icons: {
    ...defaultTheme.icons,
    ...myIcons,
  },
};
```

For typescript users, the new icons won't be available by default in the typings. To make
them available, you need to create a declaration file anywhere in your project and extend
the `CustomIcons` interface. For example:

```typescript
// src/overrides.d.ts

import 'pouncejs';
import { myIcons } from '../myTheme'; // customIcons are declare in the snippet aoove

declare module 'pouncejs' {
  type MyIcons = typeof myIcons;
  export interface CustomIcons extends MyIcons {}
}
```

This way the `my-icon` value will be available in all Components that use icons.


### SSR

SSR works out of the box with PounceJS. There's no need to anything in your NextJS or custom-SSR app to enable it.

### Performance

Pounce is on its beta phase right now, which means that the performance is constantly getting tuned.

If bundle size is something super crucial, you can safely import each module individually by doing `import Box from 'pouncejs/dist/esm/components/Box'` instead of the typical `import { Box } from 'pouncejs'` which will make sure to only pull what's needed for this particular component.

As it stands, it utilizes the latest `@emotion/xxx @ 11.x.x` internally, so if you are using a CSS-in-JS
library in your project, it would be recommended to utilize the same library at a similar major
version in order to not have two separate versions of a CSS-in-JS library in your project

## License

[Apache](https://choosealicense.com/licenses/apache-2.0/)