Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPropertyFieldStarRatingPropsInternal

interface

Private properties of the PropertyFieldStarRating custom field. We separate public & private properties to include onRender & onDispose method waited by the PropertyFieldCustom, witout asking to the developer to add it when he's using the PropertyFieldStarRating.

Hierarchy

Index

Properties

Optional context

context: any

Instance specific context. This context is passed back to the web part in the onRender and onDispose APIs. The web part can use this context to manage state information.

Optional deferredValidationTime

deferredValidationTime: number

Optional disabled

disabled: boolean

Optional emptyStarColor

emptyStarColor: string

Optional initialValue

initialValue: number

key

key: string

An UNIQUE key indicates the identity of this contorl.

The PropertyPane uses ReactJS to render its components. ReactJS uses keys to identify a component and if it should be re-rendered or not. This is a performance feature in ReactJS. Please read the following link to understand how to pick the value of the key.

see

https://facebook.github.io/react/docs/lists-and-keys.html#keys

label

label: string

Optional onGetErrorMessage

onGetErrorMessage: function

Type declaration

    • (value: number): string | Promise<string>
    • Parameters

      • value: number

      Returns string | Promise<string>

properties

properties: any

Optional starColor

starColor: string

Optional starCount

starCount: number

Optional starSize

starSize: number

targetProperty

targetProperty: string

Methods

onDispose

  • onDispose(elem: HTMLElement): void

onPropertyChange

  • onPropertyChange(propertyPath: string, oldValue: any, newValue: any): void

onRender

  • onRender(elem: HTMLElement): void

Generated using TypeDoc