{"id":19514757,"url":"https://github.com/codeeditapp/codeeditsymbols","last_synced_at":"2025-08-01T17:37:16.159Z","repository":{"id":41826318,"uuid":"482670687","full_name":"CodeEditApp/CodeEditSymbols","owner":"CodeEditApp","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-10T20:11:31.000Z","size":317,"stargazers_count":23,"open_issues_count":4,"forks_count":6,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-07-20T13:46:54.644Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodeEditApp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2022-04-18T00:55:12.000Z","updated_at":"2025-05-10T20:48:33.000Z","dependencies_parsed_at":"2024-11-10T23:37:38.093Z","dependency_job_id":"58fedd6e-0ae2-49a2-8f54-9df40e881782","html_url":"https://github.com/CodeEditApp/CodeEditSymbols","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/CodeEditApp/CodeEditSymbols","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeEditApp%2FCodeEditSymbols","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeEditApp%2FCodeEditSymbols/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeEditApp%2FCodeEditSymbols/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeEditApp%2FCodeEditSymbols/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeEditApp","download_url":"https://codeload.github.com/CodeEditApp/CodeEditSymbols/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeEditApp%2FCodeEditSymbols/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268268564,"owners_count":24223090,"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","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-10T23:37:29.920Z","updated_at":"2025-08-01T17:37:16.126Z","avatar_url":"https://github.com/CodeEditApp.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CodeEditSymbols\n\nA package containing all custom assets for CodeEdit. These are mostly custom [SF Symbols](https://developer.apple.com/design/human-interface-guidelines/sf-symbols/overview/#creating-custom-symbols).\n\n## How to use\n\n### `NSImage`:\n\n```swift\nimport CodeEditSymbols\n\nlet nsImage = NSImage.symbol(named: \"name_of_the_symbol\")\n\n// or using the static property:\n\nlet nsImage1 = NSImage.name_of_the_symbol\n```\n\n### `Image`:\n\n```swift\nimport CodeEditSymbols\n\nlet image = Image(symbol: \"name_of_the_symbol\")\n\n// or using the static property:\n\nlet image1 = Image.name_of_the_symbol\n```\n\n## Creating a new Asset\n\nTo create a new asset, follow the guide on [Apple's developer website](https://developer.apple.com/documentation/uikit/uiimage/creating_custom_symbol_images_for_your_app).\n\nAdd the `.svg` you exported from `SF Symbols.app` to the `Symbols.xcassets` catalog.\n\nAlso add a static property to the `Image` and `NSImage` extension like so:\n\n```swift\n// Image Extension\nstatic let your_symbol_name: Image = .init(symbol: \"your_symbol_name\")\n\n// NSImage Extension\nstatic let your_symbol_name: NSImage = .symbol(named: \"your_symbol_name\")\n```\n\n\u003e **Important:** Make sure your symbol looks great in every font weight.\n\n## Tests\n\nAlso include snapshot tests for each symbol for `Image` as well as `NSImage`:\n\n### `NSImage`:\n\n```swift\n// MARK: YOUR_SYMBOL_NAME\n\nfunc testCreateNSImageYourSymbolName() {\n    let image = NSImage.your_symbol_name\n    let view = NSImageView(image: image)\n    view.appearance = .init(named: .aqua)\n    assertSnapshot(matching: view, as: .image, record: record)\n}\n```\n\n### `Image`:\n\n```swift\n// MARK: YOUR_SYMBOL_NAME\n\nfunc testCreateImageYourSymbolName() {\n    let image = Image.your_symbol_name\n    let view: NSView = NSHostingController(rootView: image).view\n    view.appearance = .init(named: .aqua)\n    assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize))\n}\n```\n\n## Variants\n\nKeep different variants of a symbol in the same parent folder and name them appropriately (see Apple's own symbols for reference).\n\nYou might have a symbol called `lock` and one where the symbol is inside a square where you would call that file `lock.square`. Also keep in mind to also provide a `.fill` variant if appropriate (`lock.fill`, `lock.square.fill`)\n\n### Example of a `.fill` Variant\n\n\u003cimg width=\"256\" alt=\"Screen Shot 2022-04-18 at 00 29 57\" src=\"https://user-images.githubusercontent.com/9460130/163734754-9eff9671-bb19-46de-92b0-c4c0de27c23b.png\"\u003e\n\n## Annotate the Symbol\n\nAs of version 3 of `SF Symbols` it is possible to create `multi-color`, `hierarchical` and `palette` annotations inside the `SF Symbols.app`. Be sure to annotate it accordingly if appropriate.\n\n\u003cimg width=\"266\" alt=\"Screen Shot 2022-04-18 at 00 40 26\" src=\"https://user-images.githubusercontent.com/9460130/163734926-d4da422a-d7f0-4b93-a05b-3d1700c1b97c.png\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeeditapp%2Fcodeeditsymbols","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeeditapp%2Fcodeeditsymbols","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeeditapp%2Fcodeeditsymbols/lists"}