{"id":13431921,"url":"https://github.com/Kureev/react-native-side-menu","last_synced_at":"2025-03-16T22:32:46.012Z","repository":{"id":29875761,"uuid":"33421027","full_name":"Kureev/react-native-side-menu","owner":"Kureev","description":"Side menu component for React Native","archived":true,"fork":false,"pushed_at":"2020-09-04T20:19:15.000Z","size":721,"stargazers_count":2214,"open_issues_count":78,"forks_count":438,"subscribers_count":40,"default_branch":"master","last_synced_at":"2024-05-17T07:02:26.076Z","etag":null,"topics":["javascript","react-native","react-native-component","side-menu"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Kureev.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}},"created_at":"2015-04-04T21:29:42.000Z","updated_at":"2024-05-08T02:58:03.000Z","dependencies_parsed_at":"2022-07-10T13:17:11.560Z","dependency_job_id":null,"html_url":"https://github.com/Kureev/react-native-side-menu","commit_stats":null,"previous_names":["react-native-community/react-native-side-menu","react-native-fellowship/react-native-side-menu"],"tags_count":64,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kureev%2Freact-native-side-menu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kureev%2Freact-native-side-menu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kureev%2Freact-native-side-menu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kureev%2Freact-native-side-menu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kureev","download_url":"https://codeload.github.com/Kureev/react-native-side-menu/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243944949,"owners_count":20372885,"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":["javascript","react-native","react-native-component","side-menu"],"created_at":"2024-07-31T02:01:07.035Z","updated_at":"2025-03-16T22:32:45.625Z","avatar_url":"https://github.com/Kureev.png","language":"JavaScript","readme":"## Customizable side menu for react-native\n\n| iOS | android |\n| --- | --- |\n| \u003cimg src=\"https://user-images.githubusercontent.com/6936373/71641602-eb969700-2ce1-11ea-9698-c251ccd19b65.png\" width=\"320\" /\u003e  | \u003cimg src=\"https://user-images.githubusercontent.com/6936373/71641601-eb969700-2ce1-11ea-82e3-c09a63145989.png\" width=\"320\" /\u003e  |\n\n\n### Content\n- [Installation](#installation)\n- [Usage example](#usage-example)\n- [Component props](#component-props)\n- [Questions?](#questions)\n\n### Installation\n```bash\nnpm install react-native-side-menu --save\n```\n\n### Usage example\n```javascript\nimport SideMenu from 'react-native-side-menu'\n\nclass ContentView extends React.Component {\n  render() {\n    return (\n      \u003cView style={styles.container}\u003e\n        \u003cText style={styles.welcome}\u003e\n          Welcome to React Native!\n        \u003c/Text\u003e\n        \u003cText style={styles.instructions}\u003e\n          To get started, edit index.ios.js\n        \u003c/Text\u003e\n        \u003cText style={styles.instructions}\u003e\n          Press Cmd+R to reload,{'\\n'}\n          Cmd+Control+Z for dev menu\n        \u003c/Text\u003e\n      \u003c/View\u003e\n    );\n  }\n}\n\nclass Application extends React.Component {\n  render() {\n    const menu = \u003cMenu navigator={navigator}/\u003e;\n\n    return (\n      \u003cSideMenu menu={menu}\u003e\n        \u003cContentView/\u003e\n      \u003c/SideMenu\u003e\n    );\n  }\n}\n```\n\n### Component props\n\n| prop | default | type | description |\n| ---- | ---- | ----| ---- |\n| menu | inherited | React.Component | Menu component |\n| isOpen |false | Boolean | Props driven control over menu open state |\n| openMenuOffset | 2/3 of device screen width | Number | Content view left margin if menu is opened |\n| hiddenMenuOffset | none | Number | Content view left margin if menu is hidden |\n| edgeHitWidth | none | Number | Edge distance on content view to open side menu, defaults to 60 |\n| toleranceX | none | Number | X axis tolerance |\n| toleranceY | none | Number | Y axis tolerance |\n| disableGestures | false | Bool | Disable whether the menu can be opened with gestures or not |\n| onStartShould \u003cbr /\u003e SetResponderCapture | none | Function | Function that accepts event as an argument and specify if side-menu should react on the touch or not. Check https://facebook.github.io/react-native/docs/gesture-responder-system.html for more details |\n| onChange | none | Function | Callback on menu open/close. Is passed isOpen as an argument |\n| onMove | none | Function | Callback on menu move. Is passed left as an argument |\n| onSliding | none | Function | Callback when menu is sliding. It returns a decimal from 0 to 1 which represents the percentage of menu offset between hiddenMenuOffset and openMenuOffset.|\n| menuPosition | left | String | either 'left' or 'right' |\n| animationFunction | none | (Function -\u003e Object) | Function that accept 2 arguments (prop, value) and return an object: \u003cbr /\u003e - `prop` you should use at the place you specify parameter to animate \u003cbr /\u003e - `value` you should use to specify the final value of prop |\n| onAnimationComplete | none | (Function -\u003e Void) | Function that accept 1 optional argument (event): \u003cbr /\u003e - `event` you should this to capture the animation event after the animation has successfully completed |\n| animationStyle | none | (Function -\u003e Object) | Function that accept 1 argument (value) and return an object: \u003cbr /\u003e - `value` you should use at the place you need current value of animated parameter (left offset of content view) |\n| bounceBackOnOverdraw | true | boolean | when true, content view will bounce back to openMenuOffset when dragged further |\n| autoClosing | true | boolean | When true, menu close automatically as soon as an event occurs |\n\n### FAQ\n\n#### ScrollView does not scroll to top on status bar press\n\nOn iPhone, the scroll-to-top gesture has no effect if there is more than one scroll view on-screen that has scrollsToTop set to true. Since it defaults to `true` in ReactNative, you have to set `scrollsToTop={false}` on your ScrollView inside `Menu` component in order to get it working as desired.\n\n#### The swipe animation is extremely slow\n\nTry disabling remote JS debugging (from developer menu on phone/VD)\n\n#### My SideMenu contents are visible even when the side menu is hidden\n\nEnsure that your main view has a background color applied\n\n```\n\u003cSidemenu menu={menu}\u003e\n\u003cApp style={{backgroundColor='white'}} /\u003e\n\u003c/SideMenu\u003e\n```\n### Questions?\nFeel free to contact me in [twitter](https://twitter.com/kureevalexey) or [create an issue](https://github.com/Kureev/react-native-side-menu/issues/new)\n","funding_links":[],"categories":["JavaScript","React Native [🔝](#readme)","Uncategorized"],"sub_categories":["Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FKureev%2Freact-native-side-menu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FKureev%2Freact-native-side-menu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FKureev%2Freact-native-side-menu/lists"}