Merge pull request #2 from ivteplo/library: Make this a JavaScript library

Author: ivteplo

.gitignore

@@ -0,0 +1,132 @@
+build
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -1,6 +1,16 @@
-# Bottom Sheet
-Bottom sheet, implemented in pure HTML, CSS, and JavaScript
+# HTML Sheet Element
+
+HTML Custom Element for creating sheets
+
 
 ## Features
+
 - There is a draggable area to resize the sheet
-- The sheet can be closed using a button in the top right corner or using the `Esc` key
+- The sheet can be closed using a button in the top right corner, using the `Esc` key, or by clicking outside the bottom sheet
+  - This behavior is configurable. You can turn off the `Esc` or the click outside the sheet when you want.
+
+
+## API Documentation
+
+You can find API documentation [here](./documentation/API.md)
+

documentation/API.md

@@ -0,0 +1,120 @@
+# `SheetElement`
+
+HTML Custom Element for creating sheets
+
+<details open>
+<summary><b>Example:</b> Define the element in the registry and use it in your HTML</summary>
+
+```jsx
+customElements.define("ui-sheet", SheetElement)
+
+// in HTML:
+<ui-sheet>
+  <p>Hello World!</p>
+</ui-sheet>
+```
+
+</details>
+
+<details open>
+<summary><b>Example:</b> Sheet open by default</summary>
+
+```jsx
+<ui-sheet open>
+  <p>Hello World!</p>
+</ui-sheet>
+```
+
+</details>
+
+<details open>
+<summary><b>Example:</b> Execute certain actions when the sheet opens or closes</summary>
+
+```jsx
+const sheet = document.querySelector("...")
+
+sheet.addEventListener("show", event => {
+  console.log("The sheet is now shown")
+})
+
+sheet.addEventListener("close", event => {
+  console.log("The sheet is now closed")
+})
+```
+
+</details>
+
+<details open>
+<summary><b>Example:</b> Open the sheet programmatically</summary>
+
+```jsx
+const sheet = document.querySelector("...")
+
+sheet.showModal()
+// is the same as:
+sheet.show()
+```
+
+</details>
+
+
+## `options`
+
+Options for behavior customization
+
+<details open>
+<summary><b>Example:</b> Make the sheet <i>not</i> close on background click</summary>
+
+```jsx
+<ui-sheet ignore-background-click>
+  ...
+</ui-sheet>
+```
+
+</details>
+
+<details open>
+<summary><b>Example:</b> Make the sheet <i>not</i> close when pressing Escape</summary>
+
+```jsx
+<ui-sheet ignore-escape-key>
+  ...
+</ui-sheet>
+```
+
+</details>
+
+
+## `showModal(): void`
+
+Open the sheet
+
+
+## `show(): void`
+
+Open the sheet
+
+
+## `close(): void`
+
+Collapse the sheet
+
+
+## `get open(): boolean`
+
+Check if the sheet is open
+
+
+## `set open(value: boolean): boolean`
+
+An alternative way to open or close the sheet
+
+<details open>
+<summary><b>Example</b></summary>
+
+```jsx
+sheet.open = true  // the same as executing sheet.showModal()
+sheet.open = false // the same as executing sheet.close()
+```
+
+</details>