Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,21 @@ UI components for Hypothesis front-end applications.
Your project must have `preact` and `tailwindcss` as dependencies.

```sh
$ yarn add preact tailwindcss
$ yarn add preact tailwindcss @tailwindcss/postcss
$ yarn add @hypothesis/frontend-shared
```

### tailwindcss configuration
In your project's CSS entry point, add a `@source` for the frontend-shared
package and import the Tailwind theme:

Update your project's tailwind configuration:
```css
@import 'tailwindcss' source(none);

```js
import tailwindConfig from '@hypothesis/frontend-shared/lib/tailwind.preset.js';

export default {
// Use this package's preset
presets: [tailwindConfig],
content: [
// Be sure to add this project's component source to your
// tailwind content globs
'./node_modules/@hypothesis/frontend-shared/lib/**/*.{js,ts,tsx}',
],
// ...
/* Configure source files to scan for Tailwind classes. */
@source './node_modules/@hypothesis/frontend-shared/lib/**/*.js';

/* Import theme and utilities from shared package. */
@import '@hypothesis/frontend-shared/tailwind-config.css';
```

## Documentation
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@
"exports": {
".": "./lib/index.js",
"./pattern-library": "./lib/pattern-library/index.js",
"./tailwind.preset.js": "./lib/tailwind.preset.js",
"./tailwind-config.css": "./src/tailwind-config.css"
},
"browserslist": "chrome 70, firefox 70, safari 11.1",
Expand Down
64 changes: 0 additions & 64 deletions src/tailwind.focus-visible-ring.js

This file was deleted.

172 changes: 0 additions & 172 deletions src/tailwind.preset.js

This file was deleted.

64 changes: 0 additions & 64 deletions src/tailwind.scroll-shadows.js

This file was deleted.

6 changes: 2 additions & 4 deletions styles/test.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
/**
* Stylesheet for tests
*/
/* Stylesheet for tests. */
@import 'tailwindcss';

@config '../tailwind.config.js';
@import '../src/tailwind-config.css';
Loading