Initial commit

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  root: true,
+  // This tells ESLint to load the config from the package `eslint-config-custom`
+  extends: ['custom'],
+  settings: {
+    next: {
+      rootDir: ['apps/*/'],
+    },
+  },
+};

.gitignore

@@ -0,0 +1,38 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+dist
+
+
+# dependencies
+node_modules
+.pnp
+.pnp.js
+
+# testing
+coverage
+
+# next.js
+.next/
+out/
+build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# turbo
+.turbo
+/test-results/
+/playwright-report/
+/playwright/.cache/

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  semi: true,
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'all',
+  printWidth: 120,
+};

LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 Emil Kowalski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,74 @@
+https://github.com/emilkowalski/vaul/assets/36730035/52d2319a-9c64-4a1a-9704-15b9e3fa4177
+
+Vaul is an unstyled drawer component for React that can be used as a Dialog replacement on tablet and mobile devices. It uses [Radix's Dialog primitive](https://www.radix-ui.com/docs/primitives/components/dialog#trigger) under the hood and is inspired by [this tweet](https://twitter.com/devongovett/status/1674470185783402496).
+
+## Usage
+
+To start using the library, install it in your project:
+
+```bash
+npm install vaul
+```
+
+Use the drawer in your app.
+
+```jsx
+import { Drawer } from 'vaul';
+
+function MyComponent() {
+  return (
+    <Drawer.Root>
+      <Drawer.Trigger>Open</Drawer.Trigger>
+      <Drawer.Portal>
+        <Drawer.Content>
+          <p>Content</p>
+        </Drawer.Content>
+        <Drawer.Overlay />
+      </Drawer.Portal>
+    </Drawer.Root>
+  );
+}
+```
+
+## Examples
+
+Play around with the examples on codesandbox: 
+
+- [With scaled background](https://codesandbox.io/p/sandbox/drawer-with-scale-g24vvh?file=%2Fapp%2Fmy-drawer.tsx%3A1%2C1)
+- [Without scaled background](https://codesandbox.io/p/sandbox/drawer-with-scale-forked-nx2glp?file=%2Fapp%2Fmy-drawer.tsx%3A4%2C1)
+- [Scrollable with inputs](https://codesandbox.io/p/sandbox/drawer-with-scale-forked-73f8jw?file=%2Fapp%2Fmy-drawer.tsx%3A1%2C1)
+
+## API Reference
+
+### Root
+
+Contains all parts of a dialog. Use `shouldScaleBackground` to enable background scaling, it requires an element with `[vaul-drawer-wrapper]` data attribute to scale its background, [example](https://github.com/emilkowalski/vaul/blob/main/website/src/app/layout.tsx#L13).
+Can be controlled with the `value` and `onOpenChange` props. Can be opened by default via `defaultOpen` prop.
+
+### Trigger
+
+The button that opens the dialog. [Props](https://www.radix-ui.com/docs/primitives/components/dialog#trigger).
+
+### Content
+
+Content that should be rendered in the drawer. [Props](https://www.radix-ui.com/docs/primitives/components/dialog#content).
+
+### Overlay
+
+A layer that covers the inert portion of the view when the dialog is open. [Props](https://www.radix-ui.com/docs/primitives/components/dialog#overlay).
+
+### Title
+
+An accessible title to be announced when the dialog is opened. [Props](https://www.radix-ui.com/docs/primitives/components/dialog#title).
+
+### Description
+
+An optional accessible description to be announced when the dialog is opened. [Props](https://www.radix-ui.com/docs/primitives/components/dialog#description)https://www.radix-ui.com/docs/primitives/components/dialog#description.
+
+### Close
+
+The button that closes the dialog. [Props](https://www.radix-ui.com/docs/primitives/components/dialog#close)https://www.radix-ui.com/docs/primitives/components/dialog#close.
+
+### Portal
+
+Portals your drawer into the body.

package.json

@@ -0,0 +1,50 @@
+{
+  "name": "vaul",
+  "version": "0.0.5",
+  "description": "Drawer component for React.",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.tsx",
+    "dev": "tsup src/index.tsx --watch",
+    "dev:website": "turbo run dev --filter=website...",
+    "dev:test": "turbo run dev --filter=test...",
+    "format": "prettier --write .",
+    "test": "playwright test"
+  },
+  "keywords": [
+    "react",
+    "drawer",
+    "dialog",
+    "modal"
+  ],
+  "author": "Emil Kowalski <e@emilkowal.ski>",
+  "license": "MIT",
+  "homepage": "https://vaul.emilkowal.ski/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/emilkowalski/vaul.git"
+  },
+  "bugs": {
+    "url": "https://github.com/emilkowalski/vaul/issues"
+  },
+  "devDependencies": {
+    "@radix-ui/react-dialog": "^1.0.4",
+    "eslint": "^7.32.0",
+    "prettier": "^2.5.1",
+    "tsup": "^6.4.0",
+    "turbo": "1.6"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "packageManager": "pnpm@6.32.11",
+  "dependencies": {
+    "@radix-ui/react-dialog": "^1.0.4"
+  }
+}