{"id":22545364,"url":"https://github.com/modbender/nuxt-keen-slider","last_synced_at":"2025-04-14T20:13:21.607Z","repository":{"id":226261496,"uuid":"768151117","full_name":"modbender/nuxt-keen-slider","owner":"modbender","description":"Keen Slider for lightweight best web performance","archived":false,"fork":false,"pushed_at":"2024-07-26T16:34:10.000Z","size":165,"stargazers_count":10,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T08:31:47.523Z","etag":null,"topics":[],"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/modbender.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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},"funding":{"github":["modbender"],"patreon":"modbender","open_collective":null,"ko_fi":"modbender","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"custom":["paypal.me/modbender"]}},"created_at":"2024-03-06T15:04:55.000Z","updated_at":"2025-01-19T10:55:23.000Z","dependencies_parsed_at":"2024-11-15T21:12:23.824Z","dependency_job_id":"9847cb46-5c14-4628-96ba-7ad76d1fc4e9","html_url":"https://github.com/modbender/nuxt-keen-slider","commit_stats":null,"previous_names":["modbender/nuxt-keen-slider"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modbender%2Fnuxt-keen-slider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modbender%2Fnuxt-keen-slider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modbender%2Fnuxt-keen-slider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modbender%2Fnuxt-keen-slider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/modbender","download_url":"https://codeload.github.com/modbender/nuxt-keen-slider/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248952352,"owners_count":21188426,"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":[],"created_at":"2024-12-07T14:09:44.976Z","updated_at":"2025-04-14T20:13:21.585Z","avatar_url":"https://github.com/modbender.png","language":"Vue","funding_links":["https://github.com/sponsors/modbender","https://patreon.com/modbender","https://ko-fi.com/modbender","paypal.me/modbender"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\nNuxt Keen Slider\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://npmjs.com/package/nuxt-keen-slider\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/nuxt-keen-slider/latest.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\" alt=\"Nuxt Keen Slider - NPM Package\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://npmjs.com/package/nuxt-keen-slider\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/nuxt-keen-slider.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\" alt=\"Nuxt Keen Slider - NPM Package Downloads\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://npmjs.com/package/nuxt-keen-slider\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/nuxt-keen-slider.svg?style=flat\u0026colorA=020420\u0026\" alt=\"Nuxt Keen Slider License\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://nuxt.com\"\u003e\u003cimg src=\"https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js\" alt=\"Nuxt Keen Slider - Nuxt\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\nEasy, lightweight slider or carousel creations.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://camo.githubusercontent.com/cdcc9bea5403b1c2038a27dfde6046532a5ed1f85e783767c7a19222561510e1/68747470733a2f2f6b65656e2d736c696465722e696f2f696d616765732f636172642e676966\" alt=\"Nuxt Keen Slider - Preview 1\" /\u003e\n\u003cimg src=\"https://camo.githubusercontent.com/f8b084dc85c136039f043370b8916b855f82e2720fd2355fedc16f010d746aff/68747470733a2f2f6b65656e2d736c696465722e696f2f696d616765732f64656d6f322e676966\" alt=\"Nuxt Keen Slider - Preview 2\" /\u003e\n\u003c/p\u003e\n\n\n-----\n- [🧪 \u0026nbsp;Examples](https://keen-slider.io/examples)\n- [✨ \u0026nbsp;Release Notes](/CHANGELOG.md)\n- [🏀 \u0026nbsp;Online playground](https://stackblitz.com/github/modbender/nuxt-keen-slider?file=playground%2Fapp.vue)\n\u003c!-- - [📖 \u0026nbsp;Documentation](https://example.com) --\u003e\n\n## Features\n\n- ✊**Great Performance**: Best Lighthouse Perfomance, Lowest CLS\n- ⚡**Lightweight**: No dependencies, Fast loading\n- 📱**Mobile First**: Supports multi touch and is fully responsive\n- ⚔️**Compatible**: Works in all common browsers, including \u003e= IE 10 and React Native\n- 🗼**Extensible**: Rich but simple API\n\n## Quick Setup\n\n1. Add `nuxt-keen-slider` dependency to your project\n\n    ```bash\n    # Using pnpm\n    pnpm add -D nuxt-keen-slider\n\n    # Using yarn\n    yarn add --dev nuxt-keen-slider\n\n    # Using npm\n    npm install --save-dev nuxt-keen-slider\n    ```\n\n2. Add `nuxt-keen-slider` to the `modules` section of `nuxt.config.ts`\n\n    ```js\n    export default defineNuxtConfig({\n      modules: [\n        'nuxt-keen-slider'\n      ]\n    })\n    ```\n\n3. Create a component with name of your wish, ex. `KeenSlider.vue`\n\n    ```xml\n    \u003ctemplate\u003e\n      \u003cdiv ref=\"container\" class=\"keen-slider\"\u003e\n        \u003cdiv class=\"keen-slider__slide number-slide1\"\u003e1\u003c/div\u003e\n        \u003cdiv class=\"keen-slider__slide number-slide2\"\u003e2\u003c/div\u003e\n        \u003cdiv class=\"keen-slider__slide number-slide3\"\u003e3\u003c/div\u003e\n        \u003cdiv class=\"keen-slider__slide number-slide4\"\u003e4\u003c/div\u003e\n        \u003cdiv class=\"keen-slider__slide number-slide5\"\u003e5\u003c/div\u003e\n        \u003cdiv class=\"keen-slider__slide number-slide6\"\u003e6\u003c/div\u003e\n      \u003c/div\u003e\n    \u003c/template\u003e\n\n    \u003cscript setup\u003e\n    const [container, slider] = useKeenSlider({\n      loop: true,\n      mode: \"free\",\n      slides: {\n        perView: 3,\n        spacing: 15,\n      },\n    });\n    \u003c/script\u003e\n\n    \u003cstyle\u003e\n    [class^=\"number-slide\"],\n    [class*=\" number-slide\"] {\n      background: grey;\n      display: flex;\n      align-items: center;\n      justify-content: center;\n      font-size: 50px;\n      color: #fff;\n      font-weight: 500;\n      height: 300px;\n      max-height: 100vh;\n    }\n\n    .number-slide1 {\n      background: rgb(64, 175, 255);\n      background: linear-gradient(\n        128deg,\n        rgba(64, 175, 255, 1) 0%,\n        rgba(63, 97, 255, 1) 100%\n      );\n    }\n\n    .number-slide2 {\n      background: rgb(255, 75, 64);\n      background: linear-gradient(\n        128deg,\n        rgba(255, 154, 63, 1) 0%,\n        rgba(255, 75, 64, 1) 100%\n      );\n    }\n\n    .number-slide3 {\n      background: rgb(182, 255, 64);\n      background: linear-gradient(\n        128deg,\n        rgba(182, 255, 64, 1) 0%,\n        rgba(63, 255, 71, 1) 100%\n      );\n      background: linear-gradient(\n        128deg,\n        rgba(189, 255, 83, 1) 0%,\n        rgba(43, 250, 82, 1) 100%\n      );\n    }\n\n    .number-slide4 {\n      background: rgb(64, 255, 242);\n      background: linear-gradient(\n        128deg,\n        rgba(64, 255, 242, 1) 0%,\n        rgba(63, 188, 255, 1) 100%\n      );\n    }\n\n    .number-slide5 {\n      background: rgb(255, 64, 156);\n      background: linear-gradient(\n        128deg,\n        rgba(255, 64, 156, 1) 0%,\n        rgba(255, 63, 63, 1) 100%\n      );\n    }\n    .number-slide6 {\n      background: rgb(64, 76, 255);\n      background: linear-gradient(\n        128deg,\n        rgba(64, 76, 255, 1) 0%,\n        rgba(174, 63, 255, 1) 100%\n      );\n    }\n    \u003c/style\u003e\n    ```\n\n4. Add the component anywhere you want\n\n    ```xml\n    \u003ctemplate\u003e\n      \u003cKeenSlider /\u003e\n    \u003c/template\u003e\n    ```\n\nThat's it! You can now use Nuxt Keen Slider in your Nuxt app ✨\n\n-----\n\n\u003e [!NOTE]  OPTIONAL\n\u003e I have seen **absolute 0 CLS**, maximum performance by wrapping the `Slider` component with `ClientOnly`.  \n\u003e Seems to stop working if the component is created with .client.vue extension.    \n\u003e You could try the same if you are having Lighthouse/PageSpeed score issues and you are aiming for maximum performance.\n\u003e\n\u003e **Remember**, this could not work depending on use case.\n\n```xml\n\u003ctemplate\u003e\n  \u003cClientOnly\u003e\n    \u003cKeenSlider /\u003e\n  \u003c/ClientOnly\u003e\n\u003c/template\u003e\n```\n\n## Development\n\n```bash\n# Install dependencies\npnpm install\n\n# Generate type stubs\npnpm run dev:prepare\n\n# Develop with the playground\npnpm run dev\n\n# Build the playground\npnpm run dev:build\n\n# Run ESLint\npnpm run lint\n\n# Run Vitest\npnpm run test\npnpm run test:watch\n\n# Release new version\nnpm run release\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodbender%2Fnuxt-keen-slider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodbender%2Fnuxt-keen-slider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodbender%2Fnuxt-keen-slider/lists"}