\n A NativeScript CollectionView SwipeMenu Plugin.\n \n
\n\n \n\n\n\r\n[](#table-of-contents)\r\n\r\n## Table of Contents\n\n* [Installation](#installation)\r\n* [Configuration](#configuration)\r\n* [API](#api)\r\n* [CollectionView extensions](#collectionview-extensions)\r\n\t* [Events](#events)\r\n\t* [Propert](#propert)\r\n\t* [Methods](#methods)\r\n* [Usage](#usage)\r\n\t* [Simple Example](#simple-example)\r\n* [Demos and Development](#demos-and-development)\r\n\t* [Repo Setup](#repo-setup)\r\n\t* [Build](#build)\r\n\t* [Demos](#demos)\r\n* [Contributing](#contributing)\r\n\t* [Update repo ](#update-repo-)\r\n\t* [Update readme ](#update-readme-)\r\n\t* [Update doc ](#update-doc-)\r\n\t* [Publish](#publish)\r\n\t* [modifying submodules](#modifying-submodules)\r\n* [Questions](#questions)\n\n\r\n[](#installation)\r\n\r\n## Installation\nRun the following command from the root of your project:\n\n`ns plugin add @nativescript-community/ui-collectionview-swipemenu`\n\n\r\n[](#configuration)\r\n\r\n## Configuration\n\nTo install the plugin run:\n```typescript\nimport install from '@nativescript-community/ui-collectionview-swipemenu';\ninstall();\n```\n\r\n[](#api)\r\n\r\n## API\n\n\n\r\n[](#collectionview-extensions)\r\n\r\n## CollectionView extensions\n### Events\n\n| Property | Description |\n| ------------------- | ---------------------------------------------------------------------------- |\n| swipeMenuOpen | Triggered when a menu is opened in the CollectionView. |\n| swipeMenuClose | Triggered when a menu is closed in the CollectionView. |\n\n\n### Propert\n### Methods\n\n| Name | Return | Description |\n| ------------------------------------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------- |\n| closeCurrentMenu() | `void` | Close any opened menu in the CollectionView. |\n\n\r\n[](#usage)\r\n\r\n## Usage\n\nFirst very important note. For this plugin to work correctly, collectionview items must be an object!\nThe plugin will add `startingSide` property to your items as needed to keep knowledge of which menu is opened and notify the template `SwipeMenu`. Might change in the future\n\nYou need to add `xmlns:gvs=\"@nativescript-community/ui-collectionview-swipemenu\"` to your page tag, and then simply use `` in order to add the widget to your page. Use `` to specify the template for each cell:\n\n### Simple Example\n\nCreate a simple array of objects in your JS/TS file.\n\n```typescript\nconst items = [\n { index: 0, name: 'TURQUOISE', color: '#1abc9c' },\n { index: 1, name: 'EMERALD', color: '#2ecc71' },\n { index: 2, name: 'PETER RIVER', color: '#3498db' },\n { index: 3, name: 'AMETHYST', color: '#9b59b6' },\n { index: 4, name: 'WET ASPHALT', color: '#34495e' },\n { index: 5, name: 'GREEN SEA', color: '#16a085' },\n { index: 6, name: 'NEPHRITIS', color: '#27ae60' },\n { index: 7, name: 'BELIZE HOLE', color: '#2980b9' },\n { index: 8, name: 'WISTERIA', color: '#8e44ad' },\n { index: 9, name: 'MIDNIGHT BLUE', color: '#2c3e50' }\n];\n```\n\n```xml\n\n\n \n \n \n \n \n \n \n \n\n```\n\n\r\n[](#demos-and-development)\r\n\r\n## Demos and Development\n\n\n### Repo Setup\n\nThe repo uses submodules. If you did not clone with ` --recursive` then you need to call\n```\ngit submodule update --init\n```\n\nThe package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.\n\nTo develop and test:\nif you use `yarn` then run `yarn`\nif you use `pnpm` then run `pnpm i`\n\n**Interactive Menu:**\n\nTo start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.\n\n### Build\n\n```bash\nnpm run build.all\n```\nWARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`\n\n### Demos\n\n```bash\nnpm run demo.[ng|react|svelte|vue].[ios|android]\n\nnpm run demo.svelte.ios # Example\n```\n\nDemo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`\nInstead you work in `demo-snippets/[ng|react|svelte|vue]`\nYou can start from the `install.ts` of each flavor to see how to register new demos \n\n\r\n[](#contributing)\r\n\r\n## Contributing\n\n### Update repo \n\nYou can update the repo files quite easily\n\nFirst update the submodules\n\n```bash\nnpm run update\n```\n\nThen commit the changes\nThen update common files\n\n```bash\nnpm run sync\n```\nThen you can run `yarn|pnpm`, commit changed files if any\n\n### Update readme \n```bash\nnpm run readme\n```\n\n### Update doc \n```bash\nnpm run doc\n```\n\n### Publish\n\nThe publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)\nSimply run \n```shell\nnpm run publish\n```\n\n### modifying submodules\n\nThe repo uses https:// for submodules which means you won't be able to push directly into the submodules.\nOne easy solution is t modify `~/.gitconfig` and add\n```\n[url \"ssh://git@github.com/\"]\n\tpushInsteadOf = https://github.com/\n```\n\n\r\n[](#questions)\r\n\r\n## Questions\n\nIf you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).","readmeFilename":"README.md"}
![\"Downloads](\"https://img.shields.io/npm/dm/@nativescript-community/ui-collectionview-swipemenu.svg\")
\r\n![\"NPM](\"https://img.shields.io/npm/v/@nativescript-community/ui-collectionview-swipemenu.svg\")
\n\t