{"id":20878906,"url":"https://github.com/codeandtheory/ysidemenu-ios","last_synced_at":"2026-04-24T06:33:35.203Z","repository":{"id":188143683,"uuid":"627752224","full_name":"codeandtheory/ysidemenu-ios","owner":"codeandtheory","description":"Accessible and customizable side menu for iOS.","archived":false,"fork":false,"pushed_at":"2023-05-09T21:24:10.000Z","size":29,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-12-27T16:13:59.221Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeandtheory.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":"CODEOWNERS","security":null,"support":null,"governance":null}},"created_at":"2023-04-14T06:01:48.000Z","updated_at":"2023-10-01T10:53:38.000Z","dependencies_parsed_at":"2023-08-14T00:41:30.908Z","dependency_job_id":"55e07ee1-d0d7-4430-9a9c-733bc0af956d","html_url":"https://github.com/codeandtheory/ysidemenu-ios","commit_stats":null,"previous_names":["yml-org/ysidemenu-ios","codeandtheory/ysidemenu-ios"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/codeandtheory/ysidemenu-ios","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fysidemenu-ios","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fysidemenu-ios/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fysidemenu-ios/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fysidemenu-ios/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeandtheory","download_url":"https://codeload.github.com/codeandtheory/ysidemenu-ios/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeandtheory%2Fysidemenu-ios/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32212807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T03:15:14.334Z","status":"ssl_error","status_checked_at":"2026-04-24T03:15:11.608Z","response_time":64,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-11-18T07:14:35.581Z","updated_at":"2026-04-24T06:33:35.188Z","avatar_url":"https://github.com/codeandtheory.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Y—SideMenu](https://user-images.githubusercontent.com/1037520/232458793-f0765475-5100-48ad-9d8c-af2e9b53bd5d.jpeg)\n_Accessible and customizable side menu for iOS._\n\nLicensing\n----------\nY—SideMenu is licensed under the [Apache 2.0 license](LICENSE).\n\nDocumentation\n----------\n\nDocumentation is automatically generated from source code comments and rendered as a static website hosted via GitHub Pages at: https://yml-org.github.io/ysidemenu-ios/\n\nUsage\n----------\n\nTo use `YSideMenu` in your app, you need to create an instance of `SideMenuController`, passing a child view controller as a parameter. Here is an example of how to create and present a side menu:\n```swift\nimport YSideMenu\n\nlet sideMenuController = SideMenuController(rootViewController: contentViewController)\npresent(sideMenuController, animated: true, completion: nil)\n```\n\n### Customization\n`SideMenuController` has an `appearance` property of type `Appearance`.\n\n`Appearance` lets you customize how the side menu both appears and behaves. You can customize:\n\n```swift\nlet contentViewController = ContentViewController()\nlet sideMenuController = SideMenuController(rootViewController: menuViewController)\nsideMenuController.appearance = .init(\n    dimmerColor: UIColor.black.withAlphaComponent(0.5),\n    idealWidthPercentage: 0.75,\n    maximumWidth: 300,\n    isDismissAllowed: true\n)\n```\n\n```swift\nappearance.presentAnimation = Animation(\n    duration: 0.4, \n    curve: .spring(damping: 0.6, velocity: 0.4)\n)\n\n// Present the menu with a spring animation.\npresent(sheet, animated: true)\n```\n\nYou can customize the appearance of the side menu by setting the `appearance` property of the `SideMenuController`. The `Appearance` struct contains the following properties:\n\n`dimmerColor`: the color of the dimmer view that is displayed behind the side menu (default is black with an alpha of 0.3).\n`idealWidthPercentage`: the ideal width of the side menu as a percentage of the width of the screen (default is 0.75).\n`maximumWidth`: the maximum width of the side menu in points (default is 300).\n`isDismissAllowed`: a Boolean value that indicates whether the user can dismiss the side menu by tapping outside of it or by swiping it to the left (default is true).\n`presentAnimation`: present animation \n`dismissAnimation`: dismiss animation\n\nDependencies\n----------\n\nY—SideMenu depends upon our [Y—CoreUI](https://github.com/yml-org/ycoreui)framework (which is also open source and Apache 2.0 licensed).\n\nInstallation\n----------\n\nYou can add Y—SideMenu to an Xcode project by adding it as a package dependency.\n\n1. From the **File** menu, select **Add Packages...**\n2. Enter \"[https://github.com/yml-org/ysidemenu-ios](https://github.com/yml-org/ysidemenu-ios)\" into the package repository URL text field\n3. Click **Add Package**\n\nContributing to Y—SideMenu\n----------\n\n### Requirements\n\n#### SwiftLint (linter)\n```\nbrew install swiftlint\n```\n\n#### Jazzy (documentation)\n```\nsudo gem install jazzy\n```\n\n### Setup\n\nClone the repo and open `Package.swift` in Xcode.\n\n### Versioning strategy\n\nWe utilize [semantic versioning](https://semver.org).\n\n```\n{major}.{minor}.{patch}\n```\n\ne.g.\n\n```\n1.0.5\n```\n\n### Branching strategy\n\nWe utilize a simplified branching strategy for our frameworks.\n\n* main (and development) branch is `main`\n* both feature (and bugfix) branches branch off of `main`\n* feature (and bugfix) branches are merged back into `main` as they are completed and approved.\n* `main` gets tagged with an updated version # for each release\n \n### Branch naming conventions:\n\n```\nfeature/{ticket-number}-{short-description}\nbugfix/{ticket-number}-{short-description}\n```\ne.g.\n```\nfeature/CM-44-button\nbugfix/CM-236-textview-color\n```\n\n### Pull Requests\n\nPrior to submitting a pull request you should:\n\n1. Compile and ensure there are no warnings and no errors.\n2. Run all unit tests and confirm that everything passes.\n3. Check unit test coverage and confirm that all new / modified code is fully covered.\n4. Run `swiftlint` from the command line and confirm that there are no violations.\n5. Run `jazzy` from the command line and confirm that you have 100% documentation coverage.\n6. Consider using `git rebase -i HEAD~{commit-count}` to squash your last {commit-count} commits together into functional chunks.\n7. If HEAD of the parent branch (typically `main`) has been updated since you created your branch, use `git rebase main` to rebase your branch.\n    * _Never_ merge the parent branch into your branch.\n    * _Always_ rebase your branch off of the parent branch.\n\nWhen submitting a pull request:\n\n* Use the [provided pull request template](.github/pull_request_template.md) and populate the Introduction, Purpose, and Scope fields at a minimum.\n* If you're submitting before and after screenshots, movies, or GIF's, enter them in a two-column table so that they can be viewed side-by-side.\n\nWhen merging a pull request:\n\n* Make sure the branch is rebased (not merged) off of the latest HEAD from the parent branch. This keeps our git history easy to read and understand.\n* Make sure the branch is deleted upon merge (should be automatic).\n\n### Releasing new versions\n* Tag the corresponding commit with the new version (e.g. `1.0.5`)\n* Push the local tag to remote\n\nGenerating Documentation (via Jazzy)\n----------\n\nYou can generate your own local set of documentation directly from the source code using the following command from Terminal:\n```\njazzy\n```\nThis generates a set of documentation under `/docs`. The default configuration is set in the default config file `.jazzy.yaml` file.\n\nTo view additional documentation options type:\n```\njazzy --help\n```\nA GitHub Action automatically runs each time a commit is pushed to `main` that runs Jazzy to generate the documentation for our GitHub page at: https://yml-org.github.io/ysidemenu-ios/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeandtheory%2Fysidemenu-ios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeandtheory%2Fysidemenu-ios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeandtheory%2Fysidemenu-ios/lists"}