PaperKit provides the UI and data models for building rich paper-style markup and drawing canvases on top of PencilKit, on iOS, macOS, and visionOS. You compose a document's content with the Markup protocol and its conforming types, including ImageMarkup, LinkMarkup, LoupeMarkup, and ShapeMarkup, collected within a PaperMarkup model and a MarkupOrderedSet. The framework also lets you configure the canvas and how it renders and behaves through types such as FeatureSet, RenderingOptions, MarkupInteractions, MarkupAutoresizing, and ShapeConfiguration, while identifying and validating elements with MarkupID and MarkupError.
Essentials 3
The protocol and document model that represent a paper-style markup canvas and its contents.
- PrMarkupiOS 27.0+A markup component.
- StPaperMarkupiOS 26.0+The data model object for storing markup data created from a `PaperViewController`.
- StMarkupOrderedSetiOS 27.0+An ordered set of markup elements.
Markup Elements 5
The concrete markup types you compose into a document, including images, links, loupes, and shapes.
- StImageMarkupiOS 27.0+A markup element that represents an image.
- StLinkMarkupiOS 27.0+A URL link that a person can tap on in the canvas.
- StLoupeMarkupiOS 27.0+A loupe magnifier that magnifies the content below the loupe.
- StShapeMarkupiOS 27.0+A markup element that represents a shape or text box with customizable appearance and behavior.
- StMarkupAdornmentiOS 27.0+A visual adornment that appears on top of markup content within a markup view controller.
Canvas Configuration 4
Types that configure which features the canvas exposes and how markup behaves and resizes.
- StFeatureSetiOS 26.0+The features PaperKit supports in its UI and data models.
- StMarkupInteractionsiOS 27.0+Interactions that people can perform on markup elements.
- StMarkupAutoresizingiOS 27.0+Automatic sizing behaviors for this markup.
- StShapeConfigurationiOS 26.0+A configuration that specifies the appearance of a shape.
Rendering 1
Options that control how the canvas and its markup are rendered.
- StRenderingOptionsiOS 26.0+The rendering options for drawing paper data models.
Identity and Errors 2
Values that identify markup elements and report failures.
- StMarkupIDiOS 27.0+An opaque ID for markup elements.
- EnMarkupErroriOS 26.0+The error thrown for encoding / decoding data models.
Classes 2
- ClMarkupEditViewControlleriOS 26.0+A view controller that manages the interface for inserting content into a canvas.
- ClPaperMarkupViewControlleriOS 26.0+A view controller for interactively creating and showing markup.
Enumerations 1
- EnPaperDocumentDisplayMode