Skip to content

Commit

Permalink
Updated Readme and Package.json to support basic NPM pulls (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
sureshjoshi authored Dec 9, 2024
1 parent 0f7e9d6 commit 4726cdf
Show file tree
Hide file tree
Showing 18 changed files with 373 additions and 437 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,19 @@ This can manifest in strange, but intentional, ways:
- the existence of a `Fragment` component
- ...

## Installation

```bash
npm install @robotpajamas/headlessui-svelte
```

## Documentation

Full documenation and examples will eventually live at [headlessui-svelte.com](headlessui-svelte.com)

## Progress

The target compatibility for the components below is based on [HeadlessUI React d71fb9c](https://github.com/tailwindlabs/headlessui/tree/d71fb9cd2e12f5a48617b26e6bb3db90b3e07965). A component is considered completed when most of the mapped-over tests pass, and the component functions similarly to [headlessui.com](headlessui.com).
The target compatibility for the components below is based on [HeadlessUI React 2.2.0 (d71fb9c)](https://github.com/tailwindlabs/headlessui/tree/d71fb9cd2e12f5a48617b26e6bb3db90b3e07965). A component is considered completed when most of the mapped-over tests pass, and the component functions similarly to [headlessui.com](headlessui.com).

### Forms

Expand Down
60 changes: 36 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
{
"name": "headlessui-svelte",
"description": "An unofficial port of the HeadlessUI component library to Svelte 5.",
"name": "@robotpajamas/headlessui-svelte",
"version": "2.2.0-beta.1",
"description": "An unofficial port of the HeadlessUI component library to Svelte 5+.",
"homepage": "https://headlessui-svelte.com",
"license": "MIT",
"author": {
"name": "SJ",
"email": "[email protected]",
"url": "https://sureshjoshi.com"
},
"repository": "github:robotpajamas/headlessui-svelte",
"bugs": {
"url": "https://github.com/robotpajamas/headlessui-svelte/issues"
},
"keywords": [
"a11y",
"accessibility",
Expand All @@ -14,37 +26,40 @@
"sveltejs",
"tailwindcss"
],
"version": "0.0.1",
"bugs": {
"url": "https://github.com/robotpajamas/headlessui-svelte/issues"
},
"license": "MIT",
"repository": "github:robotpajamas/headlessui-svelte",
"scripts": {
"dev": "vite dev",
"build": "vite build && pnpm run package",
"preview": "vite preview",
"package": "svelte-kit sync && svelte-package && publint",
"prepublishOnly": "pnpm run package",
"test": "pnpm run test:integration && pnpm run test:unit",
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"lint": "deno fmt --check && deno lint",
"format": "deno fmt",
"test:integration": "playwright test",
"lint": "deno fmt --check && deno lint",
"test": "pnpm run test:unit -- --run && pnpm run test:e2e",
"test:e2e": "playwright test",
"test:unit": "vitest"
},
"files": [
"dist",
"!dist/**/*.test.*",
"!dist/**/*.spec.*"
],
"sideEffects": [
"**/*.css"
],
"svelte": "./dist/index.js",
"types": "./dist/index.d.ts",
"type": "module",
"exports": {
".": {
"types": "./dist/index.d.ts",
"svelte": "./dist/index.js"
}
},
"files": [
"dist",
"!dist/**/*.test.*",
"!dist/**/*.spec.*"
],
"publishConfig": {
"access": "public"
},
"peerDependencies": {
"svelte": ">=5"
},
Expand All @@ -54,7 +69,7 @@
"@sveltejs/kit": "^2.9.0",
"@sveltejs/package": "^2.3.7",
"@sveltejs/vite-plugin-svelte": "^5.0.1",
"@tailwindcss/vite": "4.0.0-beta.5",
"@tailwindcss/vite": "4.0.0-beta.6",
"@testing-library/dom": "^10.4.0",
"@testing-library/jest-dom": "^6.6.3",
"@testing-library/svelte": "^5.2.6",
Expand All @@ -63,16 +78,13 @@
"happy-dom": "^15.11.7",
"jsdom": "^25.0.1",
"publint": "^0.2.12",
"svelte": "^5.6.0",
"svelte": "^5.9.1",
"svelte-check": "^4.1.1",
"tailwindcss": "4.0.0-beta.5",
"tailwindcss": "4.0.0-beta.6",
"tslib": "^2.8.1",
"typescript": "^5.7.2",
"vite": "^6.0.2",
"vite": "^6.0.3",
"vitest": "^2.1.8"
},
"svelte": "./dist/index.js",
"types": "./dist/index.d.ts",
"type": "module",
"packageManager": "[email protected]+sha512.c0f53ee99477ed969b82b289ad011a5d16bf1623c957e7f29eabe8d0c00b574c29b8c7f54f6c67ee710c73f285c8154d07ce44b46fe2c0eeb476a90441bac371"
"packageManager": "[email protected]+sha512.76e2379760a4328ec4415815bcd6628dee727af3779aaa4c914e3944156c4299921a89f976381ee107d41f12cfa4b66681ca9c718f0668fa0831ed4c6d8ba56c"
}
Loading

0 comments on commit 4726cdf

Please sign in to comment.