{"id":19444217,"url":"https://github.com/amirhoseinsalimi/vottom-sheet","last_synced_at":"2025-04-25T00:33:05.428Z","repository":{"id":180244620,"uuid":"658392803","full_name":"amirhoseinsalimi/vottom-sheet","owner":"amirhoseinsalimi","description":"A sleek, highly responsive, touch-friendly, full-featured Bottom Sheet component for Vue.js","archived":false,"fork":false,"pushed_at":"2024-08-26T10:18:03.000Z","size":13573,"stargazers_count":5,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-31T05:44:27.495Z","etag":null,"topics":["action-sheet","actionsheet","bottom-sheet","bottom-sheets","bottomsheet","vue","vuejs"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/amirhoseinsalimi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-25T15:57:40.000Z","updated_at":"2024-06-28T06:47:06.000Z","dependencies_parsed_at":"2024-01-24T12:28:42.757Z","dependency_job_id":"95756a3c-8e21-48ff-bb32-bcea50a36a5b","html_url":"https://github.com/amirhoseinsalimi/vottom-sheet","commit_stats":null,"previous_names":["amirhoseinsalimi/vottom-sheet"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amirhoseinsalimi%2Fvottom-sheet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amirhoseinsalimi%2Fvottom-sheet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amirhoseinsalimi%2Fvottom-sheet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amirhoseinsalimi%2Fvottom-sheet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amirhoseinsalimi","download_url":"https://codeload.github.com/amirhoseinsalimi/vottom-sheet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223976342,"owners_count":17234751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action-sheet","actionsheet","bottom-sheet","bottom-sheets","bottomsheet","vue","vuejs"],"created_at":"2024-11-10T16:05:36.386Z","updated_at":"2024-11-10T16:05:36.986Z","avatar_url":"https://github.com/amirhoseinsalimi.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vottom Sheet\n\nVottom Sheet is a touch-friendly, lightweight and easy-to-use Vue.js component\nthat allows you to create smooth bottom sheets or modal dialogs in your web\napplication.\n\n\u003cdiv style=\"text-align: center\"\u003e\n  \u003cimg src=\"demo.gif\" alt=\"Lightweight and touch-friendly Bottom Sheet component for Vue.js\" /\u003e\n\u003c/div\u003e\n\n## Features\n\n- Simple integration: Easily integrate the Vottom Sheet component into your Vue.js project with just a few lines of code.\n- Smooth animations: Enjoy smooth and elegant animations as the bottom sheet slides into view and hides.\n- Flexible: Use Vottom Sheet however you want.\n- More to come...\n\n## Installation\n\n```bash copy\n# npm:\nnpm install @amho/vottom-sheet\n```\n\n```bash copy\n# or yarn:\nyarn add @amho/vottom-sheet\n```\n\n```bash copy\n# or pnpm:\npnpm add @amho/vottom-sheet\n```\n\n## How to use\n\n```vue copy\n\u003cscript lang=\"ts\" setup\u003e\nimport { ref } from 'vue';\nimport { VottomSheet } from '@amho/vottom-sheet';\n\nconst model = ref(false);\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cbutton type=\"button\" @click=\"model = true\"\u003eOpen Vottom Sheet\u003c/button\u003e\n\n  \u003cVottomSheet v-model=\"model\" closeOnOverlayClick\u003e\n    \u003cdiv\u003eHello from Vottom Sheet!\u003c/div\u003e\n  \u003c/VottomSheet\u003e\n\u003c/template\u003e\n\n\u003cstyle src=\"@amho/vottom-sheet/style.css\" /\u003e\n```\n\n## How to use in Nuxt.js\n\nJust wrap the component inside `\u003cClientOnly\u003e` provided by Nuxt.js. This is because vottom-sheet uses browser APIs that are not available on the server.\n\n```vue copy\n\u003ctemplate\u003e\n  \u003cClientOnly\u003e\n    \u003cVottomSheet v-model=\"model\" closeOnOverlayClick\u003e\n      \u003cdiv\u003eHello from Vottom Sheet!\u003c/div\u003e\n    \u003c/VottomSheet\u003e\n  \u003c/ClientOnly\u003e\n\u003c/template\u003e\n```\n\n## Props\n\nVottom Sheet supports the following props (More props are going to be added):\n\n| Prop                  | Type                 | Required | Default Value | Description                                                                                                                                                    |\n|-----------------------|----------------------|----------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `modelValue`          | `Boolean`            | ✅        | -             | Control the visibility of the bottom sheet. Works in pair with `@update:modelValue` to enable 2-way data binding (`v-model`).                                  |\n| `fullscreen`          | `Boolean`            | ❌        | `false`       | Make the component fullscreen.                                                                                                                                 |\n| `zIndex`              | `String` or `Number` | ❌        | `0`           | Specify the `z-index` of the bottom sheet.                                                                                                                     |\n| `closeOnEscape`       | `Boolean`            | ❌        | `false`       | Whether to close the bottom sheet on `Esc` key press.                                                                                                          |\n| `eager`               | `Boolean`            | ❌        | `false`       | Force the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO. |\n| `closeOnOverlayClick` | `Boolean`            | ❌        | `false`       | Whether to close the bottom sheet if the overlay is clicked.                                                                                                   |\n| `disableSwipe`        | `Boolean`            | ❌        | `false`       | Disable the swipe-to-close functionality.                                                                                                                      |\n| `transitionDuration`  | `Boolean`            | ❌        | `300`         | Specify the transition duration of toggling the bottom sheet.                                                                                                  |\n\n## Events\n\n| Event               | Payload Type | Description                                                                                                                                    |\n|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `update:modelValue` | `Boolean`    | Works in pair with `modelValue` prop to enable 2-way data binding (`v-model`). Can be used to listen on state changes and trigger custom code. |\n\n## Slots\n\n| Slot      | Description                                                                                                                    |\n|-----------|--------------------------------------------------------------------------------------------------------------------------------|\n| `default` | Insert the content that is going to be displayed inside the bottom sheet.                                                      |\n| `handle`  | Insert a custom handle for the bottom sheet which is displayed above the `content` slot and can be used to drag the component. |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famirhoseinsalimi%2Fvottom-sheet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famirhoseinsalimi%2Fvottom-sheet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famirhoseinsalimi%2Fvottom-sheet/lists"}