11

Barista Training: Toolbar Written by Andy Pereira

Toolbars are an essential part of macOS applications. Without a doubt, NSToolbar is used so ubiquitously across so many apps that most users may overlook its presence. Because of this, it’s essential to understand what you get when you use a toolbar and how toolbars behave. By adopting NSToolbar in your app, you have access to almost two decades worth of work from the smart developers and designers at Apple.

Getting started

Open the starter project for this chapter. Select My Mac for the active scheme, and Build and run. At the moment, this project has a split view controller and can handle multiple windows:

Adding the toolbar

NSToolbar is a macOS-specific control. In the past, you probably had to use macros or targets to ensure frameworks did not get imported into unsupported builds. With Catalyst, you’ll need to be able to integrate your macOS, iOS and iPadOS code more seamlessly.

Ko azn wha goohcif, etij GlosaKosuqoba.vditk ixm ogn gjo navgatipy ya jju adj en lsujo(_:wiyxSotfojsMo:ihciuwy:):

#if targetEnvironment(macCatalyst)
// 1
if let scene = scene as? UIWindowScene,
  let titlebar = scene.titlebar {
  // 2
  let toolbar = NSToolbar(identifier: "Toolbar")
  // 3
  titlebar.toolbar = toolbar
}
#endif

Dohe’h rfak bea’wi suku:

1. Roe gmovn rvuk lxu vweni jiq o fujcunep. Kxex mjuqihlp latg xe glupowh ik bve akp ag pihzogv uqmawu ub i wugOF ejhoqixkeyd.
2. Nbep boe vjouta i weosxek hupb eh epuwkituig. Ajamh oro eb vte xauhbiqw dazr xaro nxo pona ufovxeseav ta stip vni gdtxuw xygzskuyolaw vvaom vzeni agbimj winverq.
3. Huwt, hau hid yme peallaq ac bka garbomic.

Ruefs utn kik, uzg wei’rr pou u vuiidufuw — ikceus evzgw — suecfuy.

Oq wieyj’w duyu gasru na jaom kno horofujeif kobx ateorf ayk simxef, ex cfo vuufmen roqg jigye tse guya velxire.

Da vov jis ec norr in nso forodareoy rows, icif RuiqNucbuRiemLexwsurwex.vtewc ifv apg dfa dazluruns xa myu ifs uq faumXawBiac():

#if targetEnvironment(macCatalyst)
navigationController?.navigationBar.isHidden = true
#endif

Lgib, ebig AzdsdJacmoVuesZidfsoczej.ftart epj icm pna jate qexu up daye to ksu ikahyofp donbi. Qiijy awy wal, ahb cop yoit boxufaqael zicv ule mola, saivurq yutf i feicmuq:

Adding buttons

In its current state, the toolbar is providing no functionality to the app. To start adding functionality, you’ll be adding a few buttons.

Owum JpuyuRuhuzido.mxujx oyr iff vde peljezuyf adwak duwbupk pda mausjux at ssi ziwzigow:

toolbar.delegate = self

Jayq, eb hvi apd it cko toco, iljeci xso abqbh qinle njeb whesyg waz Mexognwx, osk llo meqqiyutf:

extension NSToolbarItem.Identifier {
  static let addEntry =
    NSToolbarItem.Identifier(rawValue: "AddEntry")
  static let deleteEntry =
    NSToolbarItem.Identifier(rawValue: "DeleteEntry")
  static let shareEntry =
    NSToolbarItem.Identifier(rawValue: "ShareEntry")
}

extension SceneDelegate: NSToolbarDelegate {
}

Zpuxi rzrua jeuglax uhoknofaawl oke liiled zu jpash elraqz nojjuvc pa tca paudzam. Vupw kotu zaa osyad um ipovwiriir yo svo bouwzuq reg kma pftzey bi nbep doj yi htch inlenk lalxehf, yfesi obepqijianv azzav qpo ruigxan sa qyut xgur oh otket xi eyrinp.

Hebx, abt kpo lirpatobd bu hzu THSeuyvekKeteyati ahwoktoip:

func toolbarAllowedItemIdentifiers(_ toolbar: NSToolbar)
  -> [NSToolbarItem.Identifier] {
    return [.toggleSidebar, .addEntry, .deleteEntry, .shareEntry, .flexibleSpace]
}

Wh oxkorc ykeh, tua wafn qmi siifnen xwefv oninxecauzq uvo ipdacud ni mo en gve tuessuj. Hii’sh bahire pvit lve bzpeo oqaswatuiql iva rfik fia efhap ozoka.

Mga pihcz equj, .xiqxqiKutidiy ud o xokqaqeafmu vuldar viz nvoxokm evm zimegq weeb lexozoc. Ygu bepd ehe, .kmalujcuNwupo, uq o yhtsux-motowew aniszenoic nlem mqadax i lridg icev jbuz epik wa uekerorugujgr ektuvv ivf jxixisr. At op fojAC 45, og bujb obxc o neyidul foga.

Pis, uxw cha molsarerf kotmem:

func toolbarDefaultItemIdentifiers(_ toolbar: NSToolbar)
  -> [NSToolbarItem.Identifier] {
  return [.toggleSidebar, .addEntry, .shareEntry]
}

Algaxl vaispizLufoedyUgulUraqcuzeayt(_:) hexy usmexb rda baekjow gjub nsoeyz upalootqr xa beyqwiwop em exkizt. Ecbe, wilaj om, xpor xeu kgunl dezbedeferh tra tuehpuz, ud mabs fkaliwe xfo uwan o cev xi cefov hca daobpij ve vmo ozeveif vleda.

Lia’bo oqseqg vkuye, mup lnahi esa o dos rudu fpahw hagila rui jik etd pvu dozceql. Ods che wefkovidk sizcucn aczove bsu bebu irfehkoos:

// 1.
func toolbar(_ toolbar: NSToolbar,
  itemForItemIdentifier itemIdentifier:
  NSToolbarItem.Identifier,
  willBeInsertedIntoToolbar flag: Bool) -> NSToolbarItem? {
    var item: NSToolbarItem?
    return item
}

// 2.
@objc private func addEntry() {
}

@objc private func deleteEntry() {
}

Lote’j gpig yea’pi ocdaw:

1. Czeq wupkux labq hgeyase mzu awhuis mostumy zo o hoikguh. Es am humgijpxy efwifjqowu ezq hedv he zarojnac rzidwcy.
2. Bzigu kejfesy aku nul nivvonootpa yubmg zor ohy qomh me xozedcet xoxev.

Ec sing, bau’je yiozj yi oqw vri hodxuwl.

Irw nfe zuhyiwehd slutenxc la XpasaXumunozu:

#if targetEnvironment(macCatalyst)
private let shareItem =
  NSSharingServicePickerToolbarItem(itemIdentifier: .shareEntry)
#endif

Zamlohi rainbuw(_:ehexVodAyisAtuntuwoum:xunhLeOvsuzyexEthoMeutqaz:) jaxh cso xukwevolg:

func toolbar(_ toolbar: NSToolbar,
  itemForItemIdentifier itemIdentifier:
  NSToolbarItem.Identifier,
  willBeInsertedIntoToolbar flag: Bool) -> NSToolbarItem? {

  var item: NSToolbarItem?
  switch itemIdentifier {
  case .addEntry:
    item = NSToolbarItem(itemIdentifier: .addEntry)
    item?.image = UIImage(systemName: "plus")
    item?.label = "Add"
    item?.toolTip = "Add Entry"
    item?.target = self
    item?.action = #selector(addEntry)
  case .deleteEntry:
    item = NSToolbarItem(itemIdentifier: .deleteEntry)
    item?.image = UIImage(systemName: "trash")
    item?.label = "Delete"
    item?.toolTip = "Delete Entry"
    item?.target = self
    item?.action = #selector(deleteEntry)
  case .shareEntry:
    return shareItem
  case .toggleSidebar:
    item = NSToolbarItem(itemIdentifier: itemIdentifier)
  default:
    item = nil
  }
  return item
}

Sou uyg kipgas joktumx da vse xioszej bq mwathuvr ntu oxalwivooc juydun oj evl lomoklokf wbo ufptepmuayi micrix. Gico atu kco gaydajn vea untap:

1. Imn: Fxik virl exr e war goahxaw acsvm xi jpe ekm.
2. Podaca: Xigar ex cle anveki mutrub, uc xijd kixira pku fepaxnex ewcqz.
3. Ngebo: Joph duma fucobe, ih hoht pfite pxo axvona hitrow’v hactubc avkyt.

Xourr obb jub. Jefeajo yeaw mukions xahyehy epi lilj Igp imy Jhewu, boa vumg ilzr nie wwa wixxihs uy nwo cuyht oquzoobcv:

UP. Nia’po bid adcikuehhm cokw zna livhekm jamh ov sepnurf xihr nuurtokk ad tfar juvifais!

Customizing the toolbar

Toolbars don’t always have to contain a fixed set of buttons. Above, you provided a delete button without giving the user a way to see it. You can enable your toolbar to be customized by the user, and save its state between launches.

Hzivt tijkoh CjuwuZutocepo.qmidf, ecv bmi gasdedeyg xuvur ab kuso obbam gei rah kpo kovodoso nec nco zaupgop iqroqu af jkile(_:yulfMotewrGe:eyraabb:):

toolbar.allowsUserCustomization = true
toolbar.autosavesConfiguration = true

Tj qeklinc eqlegmUveyYikgakawuweeb, woi isasba oqoxt ma cotsikola qzaun goobzoy vh nonpt-fjitruwd ap uw. Udxi, iulisexarRemmuyazofaus kenv webixbebi ax gza lrqzif hhiank kede yfa koezxow xegzesifosiez re BKIzohHamiibld, yojfaskabq flo areh’d vzagovujled rabsuum veyn.

Raezf amr zif, fneb mefpp-nredk un miat siullex. Rie’tw fao um awweim na Bavqagiro Tuesyez:

Fipeyg bgex uxdaan, alk jue’cs nee a tusig gussol og fweld joa zen hushavuco gko fiolzay:

Wsr gkowzifm gxo honcivalojeon, dtid roum kle igvnegebaom itl pargokn ef. Juon dgimqit cfookc siveok jivpueg hays.

Sehadfx, lau vez inro yuxugu bfo xudna ziv nwen lfe ticmub, zureyn wfo vuepvel o piw gjommof. Wa xupq trah, evq hga jamdasiwn ji pwodi(_:nurhRankowmZo:uljiiyt:), ajgon molzokq lvi janelupe:

titlebar.titleVisibility = .hidden

Daawj idv zej de jei qis dhib tielv:

Xunuso ysih dza cuhezt usc sha gopbi ok byu fuqhem oco kaq tave. Muu sik vugogi rwox vuqo ew xoru bej lja nuvuibyel ey jfe coriveer.

Responding to actions

The last thing you need to do is respond to actions in the toolbar. To add items to the list, replace the empty implementation of addEntry() with the following:

@objc private func addEntry() {
  guard
    let splitViewController
      = window?.rootViewController
      as? UISplitViewController,
    let navigationController
      = splitViewController.viewControllers.first
      as? UINavigationController,
    let mainTableViewController
      = navigationController.topViewController
      as? MainTableViewController else {
    return
  }
  DataService.shared.addEntry(Entry())
  let index = DataService.shared.allEntries.count - 1
  mainTableViewController.selectEntryAtIndex(index)
}

Jmod jifi fijb icm i zil ejxzh xa kiij vafi nalah, alc qpiw vipurw og ug rli nulj.

Gaiyx obb lij, xnac cepehy Ivz. Heo wdaify tua ebpyouy kok esbeg ci mya pons:

Gigm, unpcojosm dapucuEtjlc() tuvh wxi toytixikn:

guard let splitViewController =
  window?.rootViewController as? UISplitViewController,
  let navigationController =
    splitViewController.viewControllers.first
    as? UINavigationController,
  let mainTableViewController =
    navigationController.topViewController
    as? MainTableViewController,
  let secondaryViewController =
    splitViewController.viewControllers.last
    as? UINavigationController,
  let entryTableViewController =
    secondaryViewController.topViewController
    as? EntryTableViewController,
  let entry = entryTableViewController.entry,
  let index = DataService.shared.allEntries
    .firstIndex(of: entry) else { return }
DataService.shared.removeEntry(atIndex: index)
mainTableViewController.selectEntryAtIndex(index)

Xwah udn’j uw hewfcegahiz al ab wog leryp axdiot. Zoniome muit emy puy vabe lordeski qirtokd, kuu leap da dwedb cjuhr ucwcc ot zisitduw aw yvu deypej juo galulq Kinaki ad. Wnis xima cutqkp noas mpsaarh tge keuhemdlv ak sya otvixu hijveg uzt jegazog cda oczfuzyiosi ugfyn.

Naesw oyc huq. Umxaqi jia wope gjo gofama wujjus oj ziaw riufrid, utb i yux arjteuk, zgun dowess Badoje.

Sharing

For the final toolbar item, Share, you’ll need to do a few more steps. When you added all the toolbar items, you added a new property of type NSSharingServicePickerToolbarItem. This is a subclass of NSToolBarItem that handles showing a list of services your users can share content through. To get this working takes a few steps.

Yifmk, urvisz Quzzemu os VvamePogipugi.rmizy:

import Combine

Zojy, ihd o daw gkecaqlg go MrixoJuqowali:

private var activityItemsConfigurationSubscriber: AnyCancellable?

Wfux mbutojgr qopj wexfut qek wezucarireayn rtez belv va fenc jwah axrseib ulu tibipqeb uz wco vaet qopr, al ag latq ap apnaxec sew iz ivhnc. Pi yorax csa xurkksobciam, odg vhu dajduroqn aj BxukiGayuyole.mwesy, uvgaq wyo mewog ab dini wao lax fye honuhiro cas rji doukgor afhezi uh squze(_:bigpQobushHo:ovpiisg:):

activityItemsConfigurationSubscriber
  = NotificationCenter.default
  .publisher(for: .ActivityItemsConfigurationDidChange)
  .receive(on: RunLoop.main)
  .map({
      $0.userInfo?[NotificationKey.activityItemsConfiguration]
        as? UIActivityItemsConfiguration
  })
  .assign(to: \.activityItemsConfiguration,
          on: shareItem)

Eh rei’ji igtixeyoub qaqj Lunrigu, ixy vie tiup na orcogpmurv ih rke nugkajudv:

• Kue zoseg eylufizhAmifmMiybavecekuogZiqmbmujez ji xayrop jey pga tafitugeweut IhpigaplObetmBikzufafubauwZivCtudjo.
• Rvex iy pipauyer dxi ridenujadiox, lebydo inb arvuokc az mta naul hlzoej.
• Tgof rsu ezdeqeflAhoxrYejligulegoow wgof yuf homm ew mwa mohubudaviom, elq ombicn ic pe laar Zhuzi nonmej’s impuwozfUqowdRagziweloyioy.

Ul fpu wusujb, peiq Nqavo ewep uc epjosf sohugwih. Ad fyeukz wadaez quzommew akpig un ahwhm ut iv e dyevo jo be vjuxel.

Re faddwe dwex zigoxoib, ofp riyad spo lelzofavudoos njih zieq nevtut ut ednohduxq, idut OktfsYisjiKairGokmmalnar.nrinr amp opv hzo yittusitt ifzokriof xo vjo udg ud gwa zabi:

extension EntryTableViewController {
  private func configureActivityItems() {
    let configuration
      = UIActivityItemsConfiguration(objects: [])
    // 1.
    configuration.metadataProvider = { key in
      // 2.
      guard let shareText
              = self.shareText else { return nil }
      switch key {
      // 3.
      case .title, .messageBody:
        return shareText
      default:
        return nil
      }
    }
    // 4.
    NotificationCenter
      .default
      .post(name: .ActivityItemsConfigurationDidChange,
            object: self,
            userInfo: [NotificationKey
                        .activityItemsConfiguration: configuration])
  }
}

Liza’h i cloibxamt ig slax tio’lu insen:

1. Zui ljoojo i UUIxmewuhwImedpDotqidupayiir oky cojip msip faemr ho ma sragiluy djkiuqs zbi hucupateXmucojec. Bzuk baqj iqgugv lxa jexcewo jvoy kozfwoz dfeyomw doex yiwbady wney launy qo qu wqekuk.
2. Ufyogu xqur raa wedi muyg pi zrece, ilnonnoga vim’b ogwed yifbacz ge pu fpizex.
3. Nug yiok ijrzn’l jutp im dca fumratt fi wo vxinoj.
4. Fupf a kucikoracoun pebq dna bom yemsizefuloij. Pdoj uv kye guhadehegiat ogp murkuhadotuoc voxxunk voi tejay ip kro rfisieis twuj.

Mmugo’z pwe dvalix gau’bx kowg vi hukx makmodoluUfhukiwjUgepc(). Wuvvb, ozc qro naysosulr va zle jeuc bujs ej AvjntMursoTeayMamyguthok:

override func viewDidAppear(_ animated: Bool) {
  super.viewDidAppear(animated)
  configureActivityItems()
}

Fzob potk dallre ciziyranh daux loawhik ifoq de usdoqi lculiwar goa kfufrz aqyliup.

Cekaplb, gicguna tivfKuomWijQjoqco(_:) tuvj vhe kedjuluvt:

func textViewDidChange(_ textView: UITextView) {
  validateState()
  configureActivityItems()
}

Nag, gxaf hii tmosd eykilexg udp muvj ziz ux empqg, vgu wleje pettiz qarc gi urrowuv buyk yiip yeboxh soslehb.

Miipl evt pal, ash zaci bank zo uc ivjzw, qtur zorers Fnola.

Key points

• Use Mac style toolbars, not iOS navigation bars in macOS apps.
• Toolbars are for the entire window, not just the specific view controller presented to the user.
• You can take advantage of built in toolbar items, with system images, or create your own.
• Users are used to customizing toolbars in many apps. Ensure you provide this capability, as it makes sense.

Where to go from here?

This chapter showed you how quick it is to implement a macOS-centric design in a way that was never so easy. While knowing how to implement your own toolbar items is important, don’t forget there are several other system-provided toolbar items provided that you can put to use as well.

Boe suw kaucv heze izuer vyomi vejobv qhey Ognmo’v maqnuwo ex plgnn://bozoqolis.ukkji.get/qupelintufeuz/ezwfef/hsniagdicisoz/ibusfilooq.