Coder Social home page Coder Social logo

codeeditsymbols's Introduction

CodeEditSymbols

A package containing all custom assets for CodeEdit. These are mostly custom SF Symbols.

How to use

NSImage:

import CodeEditSymbols

let nsImage = NSImage.symbol(named: "name_of_the_symbol")

// or using the static property:

let nsImage1 = NSImage.name_of_the_symbol

Image:

import CodeEditSymbols

let image = Image(symbol: "name_of_the_symbol")

// or using the static property:

let image1 = Image.name_of_the_symbol

Creating a new Asset

To create a new asset, follow the guide on Apple's developer website.

Add the .svg you exported from SF Symbols.app to the Symbols.xcassets catalog.

Also add a static property to the Image and NSImage extension like so:

// Image Extension
static let your_symbol_name: Image = .init(symbol: "your_symbol_name")

// NSImage Extension
static let your_symbol_name: NSImage = .symbol(named: "your_symbol_name")

Important: Make sure your symbol looks great in every font weight.

Tests

Also include snapshot tests for each symbol for Image as well as NSImage:

NSImage:

// MARK: YOUR_SYMBOL_NAME

func testCreateNSImageYourSymbolName() {
    let image = NSImage.your_symbol_name
    let view = NSImageView(image: image)
    view.appearance = .init(named: .aqua)
    assertSnapshot(matching: view, as: .image, record: record)
}

Image:

// MARK: YOUR_SYMBOL_NAME

func testCreateImageYourSymbolName() {
    let image = Image.your_symbol_name
    let view: NSView = NSHostingController(rootView: image).view
    view.appearance = .init(named: .aqua)
    assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize))
}

Variants

Keep different variants of a symbol in the same parent folder and name them appropriately (see Apple's own symbols for reference).

You 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)

Example of a .fill Variant

Screen Shot 2022-04-18 at 00 29 57

Annotate the Symbol

As 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.

Screen Shot 2022-04-18 at 00 40 26

codeeditsymbols's People

Contributors

austincondiff avatar lukepistrol avatar zuziakaxel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

codeeditsymbols's Issues

✨ Add C++ Symbol

Description

Add C++ Symbol

Alternatives Considered

No response

Additional Context

No response

Screenshots

No response

✨ Add Typescript Symbol

Description

Add Typescript Symbol

Alternatives Considered

No response

Additional Context

No response

Screenshots

No response

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.