bps-kit 1.0.1 → 1.0.3

package/templates/vault/hig-technologies/references/maps.md

@@ -1,221 +0,0 @@
----
-title: "Maps | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/maps
-
-# Maps
-
-A map displays outdoor or indoor geographical data in your app or on your website.
-
-![A sketch of a tri-fold map, suggesting navigation. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/2438a971853ddedc25626eb9d276d71e/technologies-maps-intro%402x.png)
-
-A map uses a familiar interface that supports much of the same functionality as the system-provided Maps app, such as zooming, panning, and rotation. A map can also include annotations and overlays and show routing information, and you can configure it to use a standard graphical view, a satellite image-based view, or a view that’s a hybrid of both.
-
-## [Best practices](https://developer.apple.com/design/human-interface-guidelines/maps#Best-practices)
-
-**In general, make your map interactive.** People expect to be able to zoom, pan, and otherwise interact with maps in familiar ways. Noninteractive elements that obscure the map can interfere with people’s expectations for how maps behave.
-
-**Pick a map emphasis style that suits the needs of your app.** There are two emphasis styles to choose from:
-
-  * The _default_ style presents a version of the map with fully saturated colors, and is a good option for most standard map applications without a lot of custom elements. This style is also useful for keeping visual alignment between your map and the Maps app, in situations when people might switch between them.
-
-  * The _muted_ style, by contrast, presents a desaturated version of the map. This style is great if you have a lot of information-rich content that you want to stand out against the map.
-
-
-
-
-![A screenshot of a map on iPhone showing Coit Tower with the default emphasis style.](https://docs-assets.developer.apple.com/published/603ad0c458f464ad072a94aa10ee89bb/maps-default-appearance%402x.png)
-
-Default style
-
-![A screenshot of a map on iPhone showing Coit Tower with desaturated colors, representing the muted emphasis style.](https://docs-assets.developer.apple.com/published/31d94cbb32ab028e061cfff44b8e7c6a/maps-muted-appearance%402x.png)
-
-Muted style
-
-For developer guidance, see [`MKStandardMapConfiguration.EmphasisStyle`](https://developer.apple.com/documentation/MapKit/MKStandardMapConfiguration/EmphasisStyle-swift.enum).
-
-**Help people find places in your map.** Consider offering a search feature combined with a way to filter locations by category. The search field for a shopping mall map, for example, might include filters that make it easy to find common store types, like clothing, housewares, electronics, jewelry, and toys.
-
-**Clearly identify elements that people select.** When someone selects a specific area or other element on the map, use distinct styling like an outline and color variation to call attention to the selection.
-
-**Cluster overlapping points of interest to improve map legibility.** A _cluster_ uses a single pin to represent multiple points of interest within close proximity. As people zoom in on a map, clusters expand to progressively reveal individual points of interest.
-
-![A screenshot of a single pin with the number three, representing a cluster of three points of interest that are within close proximity.](https://docs-assets.developer.apple.com/published/26a4541efb07044a1fa8f7a06cd0551c/maps-points-of-interest-cluster%402x.png)Points of interest in a cluster
-
-![A screenshot of three orange pins when zoomed in, representing three individual points of interest.](https://docs-assets.developer.apple.com/published/bb8de6a531cbd567d480addff18221ee/maps-points-of-interest-individual%402x.png)Individual points of interest when zoomed in
-
-**Help people see the Apple logo and legal link.** It’s fine when parts of your interface temporarily cover the logo and link, but don’t cover these elements all the time. Follow these guidelines to help keep the Apple logo and legal link visible:
-
-  * Use adequate padding to separate the logo and link from the map boundaries and your custom controls. For example, it works well to use 7 points of padding on the sides of the elements and 10 points above and below them.
-
-  * Avoid causing the logo and link to move with your interface. It’s best when the Apple logo and legal link appear to be fixed to the map.
-
-  * If your custom interface can move relative to the map, use the lowest position of the custom element to determine the placement of the logo and link. For example, if your app lets people pull up a custom card from the bottom of the screen, place the Apple logo and legal link 10 points above the lowest resting position of the card.
-
-
-
-
-Note
-
-The Apple logo and legal link aren’t shown on maps that are smaller than 200x100 pixels.
-
-## [Custom information](https://developer.apple.com/design/human-interface-guidelines/maps#Custom-information)
-
-**Use annotations that match the visual style of your app.** Annotations identify custom points of interest on your map. The default annotation marker has a red tint and a white pin icon. You can change the tint to match the color scheme of your app. You can also change the icon to a string or image, like a logo. An icon string can contain any characters, including Unicode characters, but keep it to two to three characters in length for readability. For developer guidance, see [`MKAnnotationView`](https://developer.apple.com/documentation/MapKit/MKAnnotationView).
-
-**If you want to display custom information that’s related to standard map features, consider making them independently selectable.** When you support selectable map features, the system treats Apple-provided features (including points of interest, territories, and physical features) independently from other annotations that you add. You can configure custom appearances and information to represent these features when people select them. For developer guidance, see [`MKMapFeatureOptions`](https://developer.apple.com/documentation/MapKit/MKMapFeatureOptions).
-
-**Use overlays to define map areas with a specific relationship to your content.**
-
-  * _Above roads_ , the default level, places the overlay above roads but below buildings, trees, and other features. This is great for situations where you want people to have an idea of what’s below the overlay, while still clearly understanding that it’s a defined space.
-
-  * _Above labels_ places the overlay above both roads and labels, hiding everything beneath it. This is useful for content that you want to be fully abstracted from the features of the map, or when you want to hide areas of the map that aren’t relevant.
-
-
-
-
-For developer guidance, see [Displaying overlays on a map](https://developer.apple.com/documentation/MapKit/displaying-overlays-on-a-map) and [`MKOverlayLevel`](https://developer.apple.com/documentation/MapKit/MKOverlayLevel).
-
-**Make sure there’s enough contrast between custom controls and the map.** Insufficient contrast makes controls hard to see and can cause them to blend in with the map. Consider using a thin stroke or light drop shadow to help a custom control stand out, or applying blend modes to the map area to increase its contrast with the controls atop it.
-
-## [Place cards](https://developer.apple.com/design/human-interface-guidelines/maps#Place-cards)
-
-Place cards display rich place information in your app or website, such as operating hours, phone numbers, addresses, and more. This enables you to provide structured and up-to-date information for places that you specify, and add depth to search results.
-
-### [Displaying place cards in a map](https://developer.apple.com/design/human-interface-guidelines/maps#Displaying-place-cards-in-a-map)
-
-You can present a place card that appears directly in your map anytime someone selects a place. This is a great way to provide place information in a map with multiple places that you specify, like a map of bookstores that an author plans to visit on their book signing tour. For developer guidance, see [`mapItemDetailSelectionAccessory(_:)`](https://developer.apple.com/documentation/MapKit/MapContent/mapItemDetailSelectionAccessory\(_:\)), [`mapView(_:selectionAccessoryFor:)`](https://developer.apple.com/documentation/MapKit/MKMapViewDelegate/mapView\(_:selectionAccessoryFor:\)), and [`selectionAccessory`](https://developer.apple.com/documentation/MapKitJS/Annotation/selectionAccessory).
-
-You can also display place cards for other places on a map, such as points of interest, territories, and physical features, to provide valuable context to people about nearby places. For developer guidance, see [`mapFeatureSelectionAccessory(_:)`](https://developer.apple.com/documentation/SwiftUI/View/mapFeatureSelectionAccessory\(_:\)), [`mapView(_:selectionAccessoryFor:)`](https://developer.apple.com/documentation/MapKit/MKMapViewDelegate/mapView\(_:selectionAccessoryFor:\)), and [`selectableMapFeatureSelectionAccessory`](https://developer.apple.com/documentation/MapKitJS/Map/selectableMapFeatureSelectionAccessory).
-
-Developer note
-
-In websites, you can embed a custom map that displays a place card by default for a single place that you specify. For developer guidance, see [Displaying place information using the Maps Embed API](https://developer.apple.com/documentation/MapKitJS/displaying-place-information-using-the-maps-embed-api).
-
-The system defines several place card styles, which specify the size, appearance, and information included in a place card.
-
-  * The _automatic_ style lets the system determine the place card style based on the size of your map view.
-
-  * The _callout_ style displays a place card in a popover style next to the selected place. You can further specify the style of a callout — the _full_ callout style displays a large, detailed place card, and the _compact_ callout style displays a space-saving, more concise place card. If you don’t specify a callout style, the system defaults to the _automatic_ callout style, which determines the callout style based on your map’s view size.
-
-  * The _caption_ style displays an “Open in Apple Maps” link.
-
-  * The _sheet_ style displays a place card in a [sheet](https://developer.apple.com/design/human-interface-guidelines/sheets).
-
-
-
-
-For developer guidance, see [`MapItemDetailSelectionAccessoryStyle`](https://developer.apple.com/documentation/MapKit/MapItemDetailSelectionAccessoryStyle), [`MKSelectionAccessory.MapItemDetailPresentationStyle`](https://developer.apple.com/documentation/MapKit/MKSelectionAccessory/MapItemDetailPresentationStyle), and [`PlaceSelectionAccessoryStyle`](https://developer.apple.com/documentation/MapKitJS/PlaceSelectionAccessoryStyle).
-
-  * Full callout 
-  * Compact callout 
-  * Caption 
-  * Sheet 
-
-
-
-![A screenshot of the full callout style place card in a map on iPad. The top of the place card contains a header image and the place name, category, and rating. The place card also includes a tile with operating hours; a tile with the website, phone number, and address; and a tile with an 'Open in Apple Maps' link.](https://docs-assets.developer.apple.com/published/7b978f0c16b84311c4d3f9f35d9c0fb4/maps-place-card-ipad-full%402x.png)
-
-![A screenshot of the compact callout style place card in a map on iPad. The place card includes the place name, category, shortened address, rating, and 'Open in Apple Maps' link.](https://docs-assets.developer.apple.com/published/ad7dc822fa480dfe3b4fa5d344536518/maps-place-card-ipad-compact%402x.png)
-
-![A screenshot of the caption style place card in a map on iPad. The place card contains an 'Open in Apple Maps' link.](https://docs-assets.developer.apple.com/published/f200b2f25897fefc55d30b6c5b6258c5/maps-place-card-ipad-link%402x.png)
-
-![A screenshot of the sheet style place card in a map on iPad, which appears on top of the map view. The top of the place card contains a header image and the place name, category, and rating. The place card also includes a tile with operating hours; a tile with the website, phone number, and address; and a tile with an 'Open in Apple Maps' link.](https://docs-assets.developer.apple.com/published/d5b8b635c902d62449c481531152bae9/maps-place-card-ipad-sheet%402x.png)
-
-Full callout style place cards appear differently depending on a person’s device. The system presents the full callout style place card in a popover style in iPadOS and macOS, and as a [sheet](https://developer.apple.com/design/human-interface-guidelines/sheets) in iOS.
-
-![A screenshot of the full callout style place card in a map on iPhone. The place card appears as a sheet from the bottom edge of the device.](https://docs-assets.developer.apple.com/published/6499250814a43a161484e99968aa503c/maps-place-card-iphone-full%402x.png)
-
-**Consider your map presentation when choosing a style.** The full callout style place card offers people the richest experience, presenting them with the most information about a place directly in your map. However, be sure to choose a place card style that fits in the context of your map. For example, if your app displays a small map with many annotations, consider using the compact callout style for a space-saving presentation that shows place information while maintaining the context of the other places that you specify in your map.
-
-**Make sure your place card looks great on different devices and window sizes.** If you choose to specify a style, ensure that the content in your place card remains viewable on different devices and as window sizes change. For full callout style place cards, you can set a minimum width to prevent text from overflowing on smaller devices.
-
-**Avoid duplicating information.** Consider what information you already display in your app or website when you choose a place card style. For example, the full callout style place card might display information that your app already shows. In this case, the compact callout or caption style might be a better complement.
-
-**Keep the location on your map visible when displaying a place card.** This helps people maintain a sense of where the location is on your map while getting detailed place information. You can set an offset distance for your place card and point it to the selected location. For developer guidance, see [`offset(_:)`](https://developer.apple.com/documentation/SwiftUI/View/offset\(_:\)), [`accessoryOffset`](https://developer.apple.com/documentation/MapKit/MKAnnotationView/accessoryOffset), and [`selectionAccessoryOffset`](https://developer.apple.com/documentation/MapKitJS/Annotation/selectionAccessoryOffset).
-
-### [Adding place cards outside of a map](https://developer.apple.com/design/human-interface-guidelines/maps#Adding-place-cards-outside-of-a-map)
-
-You can also display place information outside of a map in your app or website. For example, you might want to display a list of places rather than a map, like in search results or a store locator, and present a place card when people select one. For developer guidance, see [`mapItemDetailSelectionAccessory(_:)`](https://developer.apple.com/documentation/MapKit/MapContent/mapItemDetailSelectionAccessory\(_:\)), [`mapItemDetail(_:)`](https://developer.apple.com/documentation/MapKit/MKSelectionAccessory/mapItemDetail\(_:\)), and [`PlaceDetail`](https://developer.apple.com/documentation/MapKitJS/PlaceDetail).
-
-Important
-
-If you don’t display a place card directly within a map view, you must include a map in the place card. For developer guidance, see [`mapItemDetailSheet(item:displaysMap:)`](https://developer.apple.com/documentation/SwiftUI/View/mapItemDetailSheet\(item:displaysMap:\)) and [`init(mapItem:displaysMap:)`](https://developer.apple.com/documentation/MapKit/MKMapItemDetailViewController/init\(mapItem:displaysMap:\)).
-
-**Use location-related cues in surrounding content to help communicate that people can open a place card.** For example, you can display place names and addresses alongside a button for more details to help indicate that people can interact with it to get place information. For a space-efficient design, you can include a map pin icon with a place name to help communicate that people can open a place card.
-
-## [Indoor maps](https://developer.apple.com/design/human-interface-guidelines/maps#Indoor-maps)
-
-Apps connected with specific venues like shopping malls and stadiums can design custom interactive maps that help people locate and navigate to indoor points of interest. Indoor maps can include overlays that highlight specific areas, such as rooms, kiosks, and other locations. They can also include text labels, icons, and routes.
-
-  * Example 1 
-  * Example 2 
-  * Example 3 
-
-
-
-![A screenshot of a map on iPhone, displaying the San Jose International airport and the surrounding area. A card in the bottom half of the screen displays information and options, including the airport name and buttons for sharing, closing the card, navigating to the airport, calling the airport, visiting the airport's website, and more.](https://docs-assets.developer.apple.com/published/669a55f1fc7dd419351d60b4decfbbf5/indoor-maps-example1%402x.png)
-
-![A screenshot of a map on iPhone, displaying Terminal B at the San Jose International airport. Gate numbers are displayed above the terminal on the map. A minimized card containing information and options for the airport is visible at the bottom of the screen.](https://docs-assets.developer.apple.com/published/bd86841c0079e56b609826b4b97c24aa/indoor-maps-example2%402x.png)
-
-![A screenshot of a map on iPhone, displaying a close-up view of a terminal at the San Jose International airport. A security checkpoint, first aid stations, restrooms, an escalator, and a gate number are displayed on the map. A minimized card containing a search field and a Browse SJC button is visible at the bottom of the screen.](https://docs-assets.developer.apple.com/published/b36b5ea10535fbb6b42f3ca319bba1e7/indoor-maps-example3%402x.png)
-
-**Adjust map detail based on the zoom level.** Too much detail can cause a map to appear cluttered. Show large areas like rooms and buildings at all zoom levels. Then, progressively add more detailed features and labels as the map is zoomed in. An airport map might show only terminals and gates when zoomed out, but reveal individual stores and restrooms when zoomed in.
-
-![A screenshot of a map on iPhone, zoomed in to show the location of an elevator in San Jose International airport. A minimized card containing information about the elevator is visible at the bottom of the screen.](https://docs-assets.developer.apple.com/published/b4dc405bf622e949194d8b8e4394ef9f/indoor-maps-elevator%402x.png)
-
-**Use distinctive styling to differentiate the features of your map.** Using color along with icons can help distinguish different types of areas, stores, and services, and make it easy for people to quickly find what they’re looking for.
-
-**Offer a floor picker if your venue includes multiple levels.** A floor picker lets people quickly jump between floors. If you implement this feature, keep floor numbers concise for simplicity. In most cases, a list of floor numbers — rather than floor names — is sufficient.
-
-**Include surrounding areas to provide context.** Adjacent streets, playgrounds, and other nearby locations can all help orient people when they use your map. If these areas are noninteractive, use dimming and a distinct color to make them appear supplemental.
-
-![A screenshot of a map on iPhone, zoomed in to show the numbers and locations of some gates in a terminal at San Jose International airport. Other areas, including parking structures, are displayed without details. A minimized card containing a search field and a Browse SJC button is visible at the bottom of the screen.](https://docs-assets.developer.apple.com/published/222bc580a24623284ceb5a388d31521a/indoor-maps-surroundings%402x.png)
-
-**Consider supporting navigation between your venue and nearby transit points.** Make it easy to enter and exit your venue by offering routing to and from nearby bus stops, train stations, parking lots, garages, and other transit locations. You might also offer a way for people to quickly switch over to Apple Maps for additional navigation options.
-
-**Limit scrolling outside of your venue.** This can help people avoid getting lost when they swipe too hard on your map. When possible, keep at least part of your indoor map visible onscreen at all times. To help people stay oriented, you may need to adjust the amount of scrolling you permit based on the zoom level.
-
-**Design an indoor map that feels like a natural extension of your app.** Don’t try to replicate the appearance of Apple Maps. Instead, make sure area overlays, icons, and text match the visual style of your app. For guidance, see [Indoor Mapping Data Format](https://register.apple.com/resources/imdf/).
-
-![A screenshot of a custom map in an app on iPhone, showing an airport concourse. Elements of the map are tinted green to correspond with the app's UI, and custom icons represent gates, security checkpoints, and an information booth.](https://docs-assets.developer.apple.com/published/d87fb8004dcbd26d042a43ef797a1022/indoor-maps-custom-map-design%402x.png)
-
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/maps#Platform-considerations)
-
- _No additional considerations for iOS, iPadOS, macOS, tvOS, or visionOS._
-
-### [watchOS](https://developer.apple.com/design/human-interface-guidelines/maps#watchOS)
-
-On Apple Watch, maps are static snapshots of geographic locations. Place a map in your interface at design time and show the appropriate region at runtime. The displayed region isn’t interactive; tapping it opens the Maps app on Apple Watch. You can add up to five annotations to a map to highlight points of interest or other relevant information. For developer guidance, see [`WKInterfaceMap`](https://developer.apple.com/documentation/WatchKit/WKInterfaceMap).
-
-![A screenshot of a map on Apple Watch, displaying Apple Park and some of the surrounding area.](https://docs-assets.developer.apple.com/published/befea7e8b96bc123bfef582ba3857d64/maps-watch1%402x.png)
-
-**Fit the map interface element to the screen.** The entire element needs to be visible on the Apple Watch display without requiring scrolling.
-
-**Show the smallest region that encompasses the points of interest.** The content within a map interface element doesn’t scroll, so all key content must be visible within the displayed region.
-
-For developer guidance, see [`WKInterfaceMap`](https://developer.apple.com/documentation/WatchKit/WKInterfaceMap).
-
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/maps#Resources)
-
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/maps#Developer-documentation)
-
-[MapKit](https://developer.apple.com/documentation/MapKit)
-
-[MapKit JS](https://developer.apple.com/documentation/MapKitJS)
-
-[Indoor Mapping Data Format](https://register.apple.com/resources/imdf/)
-
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/maps#Videos)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/3055294D-836B-4513-B7B0-0BC5666246B0/33B45785-076C-43F4-85FC-8D11F70E7A57/9878_wide_250x141_1x.jpg) Go further with MapKit ](https://developer.apple.com/videos/play/wwdc2025/204)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/C03E6E6D-A32A-41D0-9E50-C3C6059820AA/04977BF3-7B89-4A9E-AE42-79BD268F4684/9212_wide_250x141_1x.jpg) Unlock the power of places with MapKit ](https://developer.apple.com/videos/play/wwdc2024/10097)
-
-## [Change log](https://developer.apple.com/design/human-interface-guidelines/maps#Change-log)
-
-Date| Changes  
----|---  
-December 18, 2024| Added guidance for place cards and included additional artwork.  
-September 12, 2023| Added artwork.  
-September 23, 2022| Added guidelines for presenting custom information, refined best practices, and consolidated guidance into one page.  
-  

package/templates/vault/hig-technologies/references/nfc.md

@@ -1,51 +0,0 @@
----
-title: "NFC | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/nfc
-
-# NFC
-
-Near-field communication (NFC) allows devices within a few centimeters of each other to exchange information wirelessly.
-
-![A sketch of progressively larger curved lines extending toward the right, suggesting near-field communication. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/5635074c80716ec35b369bee5dc930d0/technologies-nfc-intro%402x.png)
-
-iOS apps running on supported devices can use NFC scanning to read data from electronic tags attached to real-world objects. For example, a person can scan a toy to connect it with a video game, a shopper can scan an in-store sign to access coupons, or a retail employee can scan products to track inventory.
-
-## [In-app tag reading](https://developer.apple.com/design/human-interface-guidelines/nfc#In-app-tag-reading)
-
-An app can support single- or multiple-object scanning when the app is active, and display a scanning sheet whenever people are about to scan something.
-
-![An illustration of a scanning sheet on iPhone, which includes the text Ready to Scan and Hold your device near the NFC tag, and a Cancel button.](https://docs-assets.developer.apple.com/published/588da10ebfa2ce6ed48d0ebdd9507735/nfc-ready-to-scan%402x.png)
-
-**Don’t encourage people to make contact with physical objects.** To scan a tag, an iOS device must simply be within close proximity of the tag. It doesn’t need to actually touch the tag. Use terms like _scan_ and _hold near_ instead of _tap_ and _touch_ when asking people to scan objects.
-
-**Use approachable terminology.** Near-field communication may be unfamiliar to some people. To make it approachable, avoid referring to technical, developer-oriented terms like _NFC_ , _Core NFC_ , _Near-field communication_ , and _tag_. Instead, use friendly, conversational terms that most people will understand.
-
-Use| Don’t use  
----|---  
-Scan the [_object name_].| Scan the NFC tag.  
-Hold your iPhone near the [_object name_] to learn more about it.| To use NFC scanning, tap your phone to the [_object_].  
-  
-**Provide succinct instructional text for the scanning sheet.** Provide a complete sentence, in sentence case, with ending punctuation. Identify the object to scan, and revise the text appropriately for subsequent scans. Keep the text short to avoid truncation.
-
-First scan| Subsequent scans  
----|---  
-Hold your iPhone near the [_object name_] to learn more about it.| Now hold your iPhone near another [_object name_].  
-  
-## [Background tag reading](https://developer.apple.com/design/human-interface-guidelines/nfc#Background-tag-reading)
-
-Background tag reading lets people scan tags quickly any time, without needing to first open your app and initiate scanning. On devices that support background tag reading, the system automatically looks for nearby compatible tags whenever the screen is illuminated. After detecting and matching a tag with an app, the system shows a notification that the people can tap to send the tag data to the app for processing. Note that background reading isn’t available when an NFC scanning sheet is visible, Wallet or Apple Pay are in use, cameras are in use, the device is in Airplane Mode, and the device is locked after a restart.
-
-![An illustration of a notification banner above the Home screen on iPhone, which offers an opportunity to open a specific app to process NFC tag data detected nearby.](https://docs-assets.developer.apple.com/published/f42e796e585f504e450d1bf030a66d69/nfc-background%402x.png)
-
-**Support both background and in-app tag reading.** Your app must still provide an in-app way to scan tags, for people with devices that don’t support background tag reading.
-
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/nfc#Platform-considerations)
-
- _No additional considerations for iOS or iPadOS. Not supported in macOS, tvOS, visionOS, or watchOS._
-
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/nfc#Resources)
-
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/nfc#Developer-documentation)
-
-[Core NFC](https://developer.apple.com/documentation/CoreNFC)
-

package/templates/vault/hig-technologies/references/photo-editing.md

@@ -1,40 +0,0 @@
----
-title: "Photo editing | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/photo-editing
-
-# Photo editing
-
-Photo-editing extensions let people modify photos and videos within the Photos app by applying filters or making other changes.
-
-![A sketch of crop marks surrounded by two arrows, suggesting photo editing. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/0923c23bdf3aebd4a8b7d94e43cb0efd/technologies-photo-editing-intro%402x.png)
-
-Edits are always saved in the Photos app as new files, safely preserving the original versions.
-
-To access a photo editing extension, a photo must be in edit mode. While in edit mode, tapping the extension icon in the toolbar displays an action menu of available editing extensions. Selecting one displays the extension’s interface in a modal view containing a top toolbar. Dismissing this view confirms and saves the edit, or cancels it and returns to the Photos app.
-
-## [Best practices](https://developer.apple.com/design/human-interface-guidelines/photo-editing#Best-practices)
-
-**Confirm cancellation of edits.** Editing a photo or video can be time consuming. If someone taps the Cancel button, don’t immediately discard their changes. Ask them to confirm that they really want to cancel, and inform them that any edits will be lost after cancellation. There’s no need to show this confirmation if no edits have been made yet.
-
-**Don’t provide a custom top toolbar.** Your extension loads within a modal view that already includes a toolbar. Providing a second toolbar is confusing and takes space away from the content being edited.
-
-**Let people preview edits.** It’s hard to approve an edit if you can’t see what it looks like. Let people see the result of their work before closing your extension and returning to the Photos app.
-
-**Use your app icon for your photo editing extension icon.** This instills confidence that the extension is in fact provided by your app.
-
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/photo-editing#Platform-considerations)
-
- _No additional considerations for iOS, iPadOS, or macOS. Not supported in tvOS, visionOS, or watchOS._
-
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/photo-editing#Resources)
-
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/photo-editing#Developer-documentation)
-
-[App extensions](https://developer.apple.com/app-extensions/)
-
-[PhotoKit](https://developer.apple.com/documentation/PhotoKit)
-
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/photo-editing#Videos)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/48/022CCFA2-C212-48DB-A086-2068695D160D/2961_wide_250x141_1x.jpg) Introducing Photo Segmentation Mattes ](https://developer.apple.com/videos/play/wwdc2019/260)
-

package/templates/vault/hig-technologies/references/researchkit.md

@@ -1,134 +0,0 @@
----
-title: "ResearchKit | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/researchkit
-
-# ResearchKit
-
-A research app lets people everywhere participate in important medical research studies.
-
-![A sketch of the ResearchKit icon. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/9bd44d7f951617f42270a366911fe357/technologies-ResearchKit-intro%402x.png)
-
-The ResearchKit framework provides predesigned screens and transitions that make it easy to design and build an engaging custom research app. For developer guidance, see [Research & Care > ResearchKit](https://www.researchandcare.org/researchkit/).
-
-These guidelines are for informational purposes only and don’t constitute legal advice. Contact an attorney to obtain advice with respect to the development of a research app and any applicable laws.
-
-## [Creating the onboarding experience](https://developer.apple.com/design/human-interface-guidelines/researchkit#Creating-the-onboarding-experience)
-
-When opening a research app for the first time, people encounter a series of screens that introduce them to the study, determine their eligibility to participate, request permission to proceed with the study, and, when appropriate, grant access to personal data. These screens aren’t typically revisited once they’ve been completed, so clarity is essential.
-
-**Always display the onboarding screens in the correct order.**
-
-![A diagram showing four boxes in a horizontal row. Beginning with the leftmost box, an arrow pointing toward the right connects each box to the next. From the left, the boxes are labeled Introduction, Eligibility, Informed consent, and Permission to access data.](https://docs-assets.developer.apple.com/published/e6a857b89c1b4b7b254861411fa0d08d/researchkit-diagram%402x.png)
-
-### [1\. Introduction](https://developer.apple.com/design/human-interface-guidelines/researchkit#1-Introduction)
-
-**Provide an introduction that informs and provides a call to action.** Clearly describe the subject and purpose of your study. Also allow existing participants to quickly log in and continue an in-progress study.
-
-![A screenshot that shows a ResearchKit app's introductory screen on iPhone, which invites someone to join a study.](https://docs-assets.developer.apple.com/published/b2e12c8eeedeb58c2b31f6da926be952/introduction-screen%402x.png)
-
-### [2\. Determine eligibility](https://developer.apple.com/design/human-interface-guidelines/researchkit#2-Determine-eligibility)
-
-**Determine eligibility as soon as possible.** People don’t need to move on to the consent section if they’re not eligible for the study. Only present eligibility requirements that are necessary for your study. Use simple, straightforward language that describes the requirements, and make it easy to enter information.
-
-![A screenshot that shows a ResearchKit app's eligibility screen on iPhone. The screen includes fields that ask for a person's age, location, and type of smartphone. The bottom of the screen includes 'Back' and 'Submit' buttons, and the top of the screen includes a button for returning to the previous screen and a button for help.](https://docs-assets.developer.apple.com/published/c458c3b78dc70a5ec20e2fbcfdfcce32/eligibility-screen%402x.png)
-
-### [3\. Get informed consent](https://developer.apple.com/design/human-interface-guidelines/researchkit#3-Get-informed-consent)
-
-**Make sure participants understand your study before you get their consent.** ResearchKit helps you make the consent process concise and friendly, while still allowing you to incorporate into the consent any legal requirements or requirements set by an institutional review board or ethics review board. Make sure that your app complies with the applicable App Store Guidelines, including the consent requirements. Typically, the consent section explains how the study works, ensures that participants understand the study and their responsibilities, and gets the participant’s consent.
-
-**Break a long consent form into easily digestible sections.** Each section can cover one aspect of the study, such as data gathering, data use, potential benefits, possible risks, time commitment, how to withdraw, and so on. For each section, use simple, straightforward language to provide a high-level overview. If necessary, provide a more detailed explanation of the section that participants can read by tapping a Learn More button. Participants need to be able to view the entire consent form before they agree to participate.
-
-**If it makes sense, provide a quiz that tests the participant’s understanding.** You might do this for questions the participant would otherwise be asked when obtaining consent in person.
-
-![A screenshot that shows a ResearchKit app's quiz screen on iPhone. The screen displays a multiple-choice question designed to make sure people understand the study. The bottom of the screen includes a 'Next' button, and the top of the screen includes a button for returning to the previous screen and a button for help.](https://docs-assets.developer.apple.com/published/09184ffb5a698e998d39bb44458911a8/consent-quiz-screen%402x.png)
-
-**Get the participant’s consent and, if appropriate, some contact information.** After agreeing to join the study, participants receive a confirmation dialog, followed by screens in which they provide their signature and contact details. Most research apps email participants a PDF version of the consent form for their records.
-
-![A screenshot that shows a ResearchKit app's consent screen on iPhone. The screen recaps key points about the study, shows the person's name, and asks the person to confirm whether they'd like to participate in the study. The bottom of the screen includes 'Disagree' and 'Accept' buttons, and the top of the screen includes a button for returning to the previous screen and a button for help.](https://docs-assets.developer.apple.com/published/46b3fb7e5f95abccac05269223545a05/consent-signature-screen%402x.png)
-
-### [4\. Request permission to access data](https://developer.apple.com/design/human-interface-guidelines/researchkit#4-Request-permission-to-access-data)
-
-**Get permission to access the participant’s device or data, and to send notifications.** Clearly explain why your research app needs access to location, Health, or other data, and don’t request access to data that isn’t critical to your study. If your app requires it, also ask for permission to send notifications to the participant’s device.
-
-![A screenshot that shows a ResearchKit app's consent screen on iPhone. The screen recaps key points about the study, and offers the choice to share data with researchers for future research purposes, or only for this particular study. The bottom of the screen includes an 'Accept' button, and the top of the screen includes a button for returning to the previous screen and a button for help.](https://docs-assets.developer.apple.com/published/bcceaf89b0a6997c37f5179229674b84/permissions-health-data-screen%402x.png)
-
-## [Conducting research](https://developer.apple.com/design/human-interface-guidelines/researchkit#Conducting-research)
-
-To get input from participants, your study might use surveys, active tasks, or a combination of both. Depending on the architecture of your study, participants may interact with each section multiple times or only once.
-
-**Create surveys that keep participants engaged.** ResearchKit provides many customizable screens you can use in your surveys, and makes it easy to present questions that require different types of answers, such as true or false, multiple choice, dates and times, sliding scales, and open-ended text entry. As you use ResearchKit screens to design a survey, follow these guidelines to provide a great experience:
-
-  * Tell participants how many questions there are and about how long the survey will take.
-
-  * Use one screen per question.
-
-  * Show participants their progress in the survey.
-
-  * Keep the survey as short as possible. Several short surveys tend to work better than one long survey.
-
-  * For questions that require some additional explanation, use the standard font for the question and a slightly smaller font for the explanatory text.
-
-  * Tell participants when the survey is complete.
-
-
-
-
-![A screenshot that shows a ResearchKit app's survey screen on iPhone. This particular screen asks someone to specify Parkinson's disease symptoms from a list and tap a 'Next' button to continue the survey. The top of the screen includes a 'Close' button.](https://docs-assets.developer.apple.com/published/ee125d1de4ec07f41856c9bab67ee0c3/survey-question-type1-screen%402x.png)
-
-**Make active tasks easy to understand.** An active task requires the participant to engage in an activity, such as speaking into the microphone, tapping fingers on the screen, walking, or performing a memory test. Follow these guidelines to encourage participants to perform an active task and give them the best chance of success:
-
-  * Describe how to perform the task using clear, simple language.
-
-  * Explain any requirements, such as if the task must be performed at a particular time or under specific circumstances.
-
-  * Make sure participants can tell when the task is complete.
-
-
-
-
-![A screenshot that shows a ResearchKit app's active task screen on iPhone. This particular screen shows an illustration of a person walking, and instructions that explain how to perform a Walk and Balance active task. A list of requirements is shown, along with a 'Get started' button. The top of the screen includes a 'Close' button.](https://docs-assets.developer.apple.com/published/efdeed00e3196a8eaea5155ff78b0015/active-tasks-screen%402x.png)
-
-## [Managing personal information and providing encouragement](https://developer.apple.com/design/human-interface-guidelines/researchkit#Managing-personal-information-and-providing-encouragement)
-
-ResearchKit offers a profile screen you can use to let participants manage personal information while they’re in your research app. It’s also a good idea to design a custom screen that motivates people and gives them a way to track progress in the study. Ideally, both screens are accessible at all times in your app.
-
-**Use a profile to help participants manage personal data related to your study.** A profile screen can let people edit data that might change during the course of the study — such as weight or sleep habits — and remind them of upcoming activities. A profile screen can also provide an easy way to leave a study and view important information, such as the consent document and privacy policy.
-
-![A screenshot that shows a ResearchKit app's profile screen on iPhone. This particular screen includes a list of fields for personal information like name and birth year. Each field includes a button for editing the field's value. The top of the screen includes a settings button, and the bottom of the screen includes tabs for 'Tracking', 'History' and 'Profile'. The active tab is 'Profile'.](https://docs-assets.developer.apple.com/published/9112be9b40dfaec1cc5270f94adc4645/profile-screen%402x.png)
-
-**Use a dashboard to show progress and motivate participants to continue.** If appropriate for your study, use a dashboard to provide encouraging feedback, such as daily progress, weekly assessments, results from specific activities, and even results that compare the participant’s results with aggregated results from others in the study.
-
-![A screenshot that shows a ResearchKit app's history screen on iPhone. This particular screen shows a log of active tasks performed over two days. The bottom of the screen includes tabs for 'Tracking', 'History' and 'Profile'. The active tab is 'History'.](https://docs-assets.developer.apple.com/published/d5c1639ec410f2064db916c146e27f17/dashboard-screen%402x.png)
-
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/researchkit#Platform-considerations)
-
- _No additional considerations for iOS or iPadOS. Not supported in macOS, tvOS, visionOS, or watchOS._
-
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/researchkit#Resources)
-
-#### [Related](https://developer.apple.com/design/human-interface-guidelines/researchkit#Related)
-
-[Research & Care > ResearchKit](https://www.researchandcare.org/researchkit/)
-
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/researchkit#Developer-documentation)
-
-[Research & Care > Developers](https://www.researchandcare.org/developers/)
-
-[Protecting user privacy](https://developer.apple.com/documentation/HealthKit/protecting-user-privacy) — HealthKit
-
-[ResearchKit GitHub project](https://github.com/ResearchKit/ResearchKit)
-
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/researchkit#Videos)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/49/196C46B0-DF68-4947-B211-4FEECE415A6E/3408_wide_250x141_1x.jpg) What's new in CareKit ](https://developer.apple.com/videos/play/wwdc2020/10151)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/119/EAFF830B-8468-49BA-A5DC-D3A3E8B7F463/4960_wide_250x141_1x.jpg) Build a research and care app, part 1: Setup onboarding ](https://developer.apple.com/videos/play/wwdc2021/10068)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/48/E6EBBD96-C3E4-4A7E-908A-A692F708AE26/2633_wide_250x141_1x.jpg) ResearchKit and CareKit Reimagined ](https://developer.apple.com/videos/play/wwdc2019/217)
-
-## [Change log](https://developer.apple.com/design/human-interface-guidelines/researchkit#Change-log)
-
-Date| Changes  
----|---  
-September 12, 2023| Updated artwork.  
-