Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
66 lines (45 sloc) 2.33 KB

PropertyFieldToggleWithCallout control

This control generates a toggle control with a callout.

PropertyFieldToggleWithCallout rendering

Toggle field with callout

PropertyFieldToggleWithCallout callout opened

Toggle field with callout opened

How to use this control in your solutions

  1. Check that you installed the @pnp/spfx-property-controls dependency. Check out The getting started page for more information about installing the dependency.
  2. Import the following modules to your component:
import { CalloutTriggers } from '@pnp/spfx-property-controls/lib/PropertyFieldHeader';
import { PropertyFieldToggleWithCallout } from '@pnp/spfx-property-controls/lib/PropertyFieldToggleWithCallout';
  1. Create a new property for your web part, for example:
export interface IPropertyControlsTestWebPartProps {
  toggleInfoHeaderValue: boolean;
}
  1. Add the custom property control to the groupFields of the web part property pane configuration:
PropertyFieldToggleWithCallout('toggleInfoHeaderValue', {
  calloutTrigger: CalloutTriggers.Click,
  key: 'toggleInfoHeaderFieldId',
  label: 'Turn on the PnP feature',
  calloutContent: React.createElement('p', {}, 'With this control you can enable or disable the PnP features in your web part'),
  onText: 'ON',
  offText: 'OFF',
  checked: this.properties.toggleInfoHeaderValue
})

Implementation

The PropertyFieldToggleWithCallout control uses the same implementation as the default PropertyPaneToggle and has the following additional properties:

Property Type Required Description
calloutContent React.ReactNode no Callout content - any HTML
calloutWidth number no Custom width for callout including borders. If value is 0, no width is applied.
calloutTrigger CalloutTriggers no Event to show the callout
gapSpace number no The gap between the callout and the target

Enum CalloutTriggers

Name Description
Click Shows the callout when you hover over the icon
Hover Shows the callout when you click on the icon

You can’t perform that action at this time.