# sancho

Latest version **3.5.6** (published 2019-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install sancho
pnpm add sancho
yarn add sancho
bun add sancho
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.5.6 |
| Published | 2019-10-24 |
| First published | 2019-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 33 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 408 |
| Author | Ben McMahen |
| Maintainers | bmcmahen |

## Links

- npm: https://www.npmjs.com/package/sancho
- Repository: https://github.com/bmcmahen/sancho
- Homepage: https://sancho-ui.com
- Issues: https://github.com/bmcmahen/sancho/issues
- npm.io page: https://npm.io/package/sancho

## Dependencies (33)

- [color](https://npm.io/package/color.md) ^3.1.0
- [tslib](https://npm.io/package/tslib.md) ^1.9.3
- [raf-schd](https://npm.io/package/raf-schd.md) ^4.0.1
- [is-mobile](https://npm.io/package/is-mobile.md) ^2.0.0
- [popper.js](https://npm.io/package/popper.js.md) ^1.14.7
- [use-media](https://npm.io/package/use-media.md) ^1.2.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [focus-trap](https://npm.io/package/focus-trap.md) 5
- [open-color](https://npm.io/package/open-color.md) ^1.6.3
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [@reach/alert](https://npm.io/package/@reach/alert.md) ^0.1.2
- [@types/color](https://npm.io/package/@types/color.md) ^3.0.0
- [@types/react](https://npm.io/package/@types/react.md) 16.8.4
- [react-popper](https://npm.io/package/react-popper.md) ^1.3.3
- [react-spring](https://npm.io/package/react-spring.md) 9.0.0-beta.34
- [toasted-notes](https://npm.io/package/toasted-notes.md) ^2.1.6
- [touchable-hook](https://npm.io/package/touchable-hook.md) ^1.2.1
- [@reach/skip-nav](https://npm.io/package/@reach/skip-nav.md) ^0.1.2
- [use-scroll-lock](https://npm.io/package/use-scroll-lock.md) ^1.0.0
- [@types/react-dom](https://npm.io/package/@types/react-dom.md) 16.8.2
- [@types/classnames](https://npm.io/package/@types/classnames.md) ^2.2.7
- [@types/prop-types](https://npm.io/package/@types/prop-types.md) 15.7.0
- [react-gesture-stack](https://npm.io/package/react-gesture-stack.md) ^1.3.2
- [react-remove-scroll](https://npm.io/package/react-remove-scroll.md) ^2.0.4
- [react-highlight-words](https://npm.io/package/react-highlight-words.md) ^0.16.0
- [react-page-controller](https://npm.io/package/react-page-controller.md) ^3.0.1
- [@reach/visually-hidden](https://npm.io/package/@reach/visually-hidden.md) ^0.1.2
- [@types/lodash.uniqueid](https://npm.io/package/@types/lodash.uniqueid.md) ^4.0.5
- [react-gesture-responder](https://npm.io/package/react-gesture-responder.md) ^2.1.0
- [compute-scroll-into-view](https://npm.io/package/compute-scroll-into-view.md) ^1.0.11
- [resize-observer-polyfill](https://npm.io/package/resize-observer-polyfill.md) ^1.5.1
- [@types/react-highlight-words](https://npm.io/package/@types/react-highlight-words.md) ^0.16.0
- [@types/react-swipeable-views](https://npm.io/package/@types/react-swipeable-views.md) ^0.12.2

## Recent versions

- 3.5.6 (latest) — 2019-10-24
- 2.0.0-rc4 (next) — 2019-05-03
- 3.5.5 — 2019-10-10
- 3.5.4 — 2019-08-09
- 3.5.3 — 2019-08-07
- 3.5.2 — 2019-08-01
- 3.5.1 — 2019-07-24
- 3.5.0 — 2019-07-24
- 3.4.2 — 2019-07-15
- 3.4.1 — 2019-07-15
- 3.4.0 — 2019-07-15
- 3.3.3 — 2019-07-13
- 3.3.2 — 2019-07-11
- 3.3.1 — 2019-07-09
- 3.3.0 — 2019-07-09
- … 30 more at https://npm.io/package/sancho/versions

## README

<div align="center">
  <a href="https://sancho-ui.com/">
    <img 
    max-width="600px"
    alt="Sancho is a responsive and accessible design system built with React, Typescript and Emotion. Named after the ever-faithful, hilariously acerbic sidekick of Don Quixote, Sancho is designed to help you no matter how quixotic your dreams may be."
     src="https://raw.githubusercontent.com/bmcmahen/sancho/master/hero.jpg">
  </a>
</div>
<br />
<div align="center">
  
[![npm package](https://img.shields.io/npm/v/sancho/latest.svg)](https://www.npmjs.com/package/sancho)
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Sancho%20is%20a%20responsive%20and%20accessible%20design%20system%20built%20with%20React%2C%20Typescript%20and%20Emotion&url=https://sancho-ui.com&hashtags=react,design,javascript)
[![Follow on Twitter](https://img.shields.io/twitter/follow/benmcmahen.svg?style=social&logo=twitter)](
https://twitter.com/intent/follow?screen_name=benmcmahen
)

</div>

## Features

- Beautiful, generic components that you can make your own.
- Highly responsive. Sancho takes mobile seriously, with built in support for gestures.
- Accessible.
- A fully customizable theme, which includes a dark and light mode.
- Fully typed for use with Typescript.
- Support for tree shaking. Bundle only those components that you need.
- An ever-growing [list of components](https://sancho-ui.com).

[View the documentation](https://sancho-ui.com) for full details.

## Getting started

Install Sancho and Emotion using yarn or npm:

```
yarn add sancho @emotion/core @emotion/css
```

And import your desired components into your React project.

```jsx
import { Button } from "sancho";

function MyApp() {
  return <Button>Hello world</Button>;
}
```

## Sample projects

### Julienne

<div align="center">
  <a href="https://julienne.app">
    <img
    max-width="600px"
    alt="Julienne screenshot showing a list of recipes on the left, and a recipe on the right."
     src="https://raw.githubusercontent.com/bmcmahen/sancho/master/misc/julienne.jpg">
  </a>
</div>
<br />

[Julienne](https://julienne.app) is a small application built with Sancho and Firebase which helps you share recipes with family and friends. View the [source here](https://github.com/bmcmahen/julienne).

### Captioner

<div align="center">
  <a href="https://captioner.app">
    <img
    max-width="600px"
    alt="Captioner screenshot showing a user adding subtitles to the Godfather movie."
     src="https://raw.githubusercontent.com/bmcmahen/sancho/master/misc/captioner.jpg">
  </a>
</div>
<br />

[Captioner](https://captioner.app) is an in-browser tool for generating captions for your videos. It's also built with Sancho and Firebase. View the [source here](https://github.com/bmcmahen/captioner).

## Development

```
git clone https://github.com/bmcmahen/sancho.git
cd sancho
yarn
yarn run storybook
```

## License

MIT

---
_Source: https://npm.io/package/sancho · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
