struct · iOS 18.0+ · SDK 27.1
struct ConfigurationA configuration that specifies the appearance and behavior of a item and its contents.
static init(identifier: string, name: string): PKToolPickerCustomItem_Configurationinit(identifier: String, name: String)Create a new configuration. - Parameters: - identifier: The identifier for the tool item. - name: The name for the tool item.
get identifier(): stringvar identifier: StringA string that identifies the item in the picker. For example, com.example.myapp.toolpicker.pencil. If multiple items with the same identifier are used to create the picker, only the first instance is used.
set identifier(value: string)var identifier: StringA string that identifies the item in the picker. For example, com.example.myapp.toolpicker.pencil. If multiple items with the same identifier are used to create the picker, only the first instance is used.
get defaultColor(): _UIKit_UIColorvar defaultColor: UIColorDefault color for the tool. Defaults to black.
set defaultColor(value: _UIKit_UIColor)var defaultColor: UIColorDefault color for the tool. Defaults to black.
get defaultWidth(): numbervar defaultWidth: CGFloatDefault width for the tool. Defaults to 0.0.
set defaultWidth(value: number)var defaultWidth: CGFloatDefault width for the tool. Defaults to 0.0.
get imageProvider(): (((arg0: PKToolPickerCustomItem) => Promise<_UIKit_UIImage>)) | nullvar imageProvider: ((PKToolPickerCustomItem) -> UIImage)?A closure to provide an image representing the given tool item. Return an image at least 150 points tall to avoid the bottom of the item showing during animations. By default, PencilKit uses `name` to label the tool item for accessibility. To override this, set the `accessibilityLabel` of the image returned from this closure.
get widthVariants(): Record<number, _UIKit_UIImage>var widthVariants: [CGFloat : UIImage]A dictionary representing the UI options for choosing width variants, with each element containing its width value paired with its corresponding image. A dictionary with fewer than 2 elements means no selection UI is available for users to adjust the width value. A dictionary with 2 or more elements means that users can adjust the width value using the selection UI. Provide square images with a size of at least 32pts by 32pts.
set widthVariants(value: Record<number, _UIKit_UIImage>)var widthVariants: [CGFloat : UIImage]A dictionary representing the UI options for choosing width variants, with each element containing its width value paired with its corresponding image. A dictionary with fewer than 2 elements means no selection UI is available for users to adjust the width value. A dictionary with 2 or more elements means that users can adjust the width value using the selection UI. Provide square images with a size of at least 32pts by 32pts.
get allowsColorSelection(): booleanvar allowsColorSelection: BoolPresent color selection UI to the user. Note that the custom item has a mutable version of this property. This property provides its initial value. Defaults to false.
set allowsColorSelection(value: boolean)var allowsColorSelection: BoolPresent color selection UI to the user. Note that the custom item has a mutable version of this property. This property provides its initial value. Defaults to false.
get toolAttributeControls(): PKToolPickerCustomItem_ControlOptionsvar toolAttributeControls: PKToolPickerCustomItem.ControlOptionsDefines which attribute controls are available to be presented in UI such as the tool attributes popover, or inline in the picker presented from a pencil squeeze. Controls for properties which the tool item does not support will not be presented. Excluding a control here does not hide all UI for adjusting that value. For example, excluding the opacity control here will not remove it from the color picker, if the color picker is otherwise available. Defaults to all controls.
set toolAttributeControls(value: PKToolPickerCustomItem_ControlOptions)var toolAttributeControls: PKToolPickerCustomItem.ControlOptionsDefines which attribute controls are available to be presented in UI such as the tool attributes popover, or inline in the picker presented from a pencil squeeze. Controls for properties which the tool item does not support will not be presented. Excluding a control here does not hide all UI for adjusting that value. For example, excluding the opacity control here will not remove it from the color picker, if the color picker is otherwise available. Defaults to all controls.
get viewControllerProvider(): (((arg0: PKToolPickerCustomItem) => Promise<_UIKit_UIViewController>)) | nullvar viewControllerProvider: ((PKToolPickerCustomItem) -> UIViewController)?A closure to provide a view controller above the system controls in the tool attributes popover.
get name(): stringvar name: StringA short string suitable for presentation to users as the name of the tool.
set name(value: string)var name: StringA short string suitable for presentation to users as the name of the tool.
2 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.
PKToolPickerCustomItem.Configuration.imageProvider
closure property answers its caller
PKToolPickerCustomItem.Configuration.viewControllerProvider
closure property answers its caller