IPropertyPaneTextFieldProps interface

Paquete:

@microsoft/sp-property-pane

Propiedades del componente de campo de texto del panel de propiedades.

Propiedades

ariaLabel	Etiqueta de Aria para el campo de texto, si existe.
deferredValidationTime	El campo de texto empezará a validar después de que los usuarios dejen de escribir durante deferredValidationTime milisegundos.
description	Descripción de entrada del campo de texto.
disabled	Si el campo de texto del panel de propiedades está habilitado o no.
errorMessage	Si se establece, se mostrará como un mensaje de error.
label	Etiqueta para el campo de texto.
logName	Nombre que se usa para registrar PropertyPaneTextField los cambios de valor para el seguimiento de la interacción.
maxLength	Número máximo de caracteres que puede tener PropertyPaneTextField.
multiline	Si el campo de texto es o no un campo de texto multilínea.
onGetErrorMessage	El método se usa para obtener el mensaje de error de validación y determinar si el valor de entrada es válido o no.
placeholder	texto del marcador de posición que se mostrará en el campo de texto.
resizable	Si el campo de texto de varias líneas es o no modificable.
rows	Especifica el alto visible de un área de texto (textField de varias líneas), en líneas.
underlined	Si el campo de texto está subrayado o no.
validateOnFocusIn	Ejecute la validación cuando se centre PropertyPaneTextField.
validateOnFocusOut	Ejecute la validación cuando PropertyPaneTextField esté fuera de foco o en desenfoque.
value	Valor que se mostrará en el campo de texto cuando el valor de targetProperty en el contenedor de propiedades del manifiesto esté vacío o contenga un valor NULL.

Detalles de las propiedades

ariaLabel

Etiqueta de Aria para el campo de texto, si existe.

ariaLabel?: string;

Valor de propiedad

string

deferredValidationTime

El campo de texto empezará a validar después de que los usuarios dejen de escribir durante deferredValidationTime milisegundos.

deferredValidationTime?: number;

Valor de propiedad

number

Comentarios

El valor predeterminado es 200.

description

Descripción de entrada del campo de texto.

description?: string;

Valor de propiedad

string

disabled

Si el campo de texto del panel de propiedades está habilitado o no.

disabled?: boolean;

Valor de propiedad

boolean

errorMessage

Si se establece, se mostrará como un mensaje de error.

errorMessage?: string;

Valor de propiedad

string

Comentarios

Cuando onGetErrorMessage devuelve una cadena vacía, si esta propiedad tiene un valor establecido, se mostrará como el mensaje de error.

Por lo tanto, asegúrese de establecer esto solo si desea ver un mensaje de error para el campo de texto.

label

Etiqueta para el campo de texto.

label?: string;

Valor de propiedad

string

logName

Nombre que se usa para registrar PropertyPaneTextField los cambios de valor para el seguimiento de la interacción.

logName?: {
        moduleName: string;
        controlName: string;
    };

Valor de propiedad

{ moduleName: string; controlName: string; }

Comentarios

Los mensajes se registrarán con un formato como <moduleName>.<controlName>.

Por ejemplo, si {moduleName: 'ImageWebPart', controlName: 'OverlayText'} se especifica, el registro de interacción podría contener:

1. Tipo de acción:

Add : cambie del estado inicial o no establecido al contenido personalizado. (primera edición)

Clear : restablezca el contenido de subtítulo elemento al estado inicial o no establecido.

Edit : cualquier edición que cambie el contenido aparte de agregar y borrar

2. Longitud del texto después de cada edición

maxLength

Número máximo de caracteres que puede tener PropertyPaneTextField.

maxLength?: number;

Valor de propiedad

number

Comentarios

Si el valor se establece en un número negativo, se producirá una excepción.

multiline

Si el campo de texto es o no un campo de texto multilínea.

multiline?: boolean;

Valor de propiedad

boolean

Comentarios

El valor predeterminado es False.

onGetErrorMessage

El método se usa para obtener el mensaje de error de validación y determinar si el valor de entrada es válido o no.

onGetErrorMessage?: (value: string) => string | Promise<string>;

Valor de propiedad

(value: string) => string | Promise<string>

Comentarios

Cuando devuelve una cadena:

• Si es válido, devuelve una cadena vacía.

• Si no es válido, devuelve la cadena del mensaje de error y se muestra un mensaje de error debajo del campo de texto.

Cuando devuelve Promise<string>:

• El valor resuelto se muestra como mensaje de error.

• El valor rechazado se produce.

placeholder

texto del marcador de posición que se mostrará en el campo de texto.

placeholder?: string;

Valor de propiedad

string

resizable

Si el campo de texto de varias líneas es o no modificable.

resizable?: boolean;

Valor de propiedad

boolean

Comentarios

El valor predeterminado es true.

rows

Especifica el alto visible de un área de texto (textField de varias líneas), en líneas.

rows?: number;

Valor de propiedad

number

Comentarios

Esta propiedad solo se usa cuando la propiedad multilínea se establece en true.

underlined

Si el campo de texto está subrayado o no.

underlined?: boolean;

Valor de propiedad

boolean

Comentarios

El valor predeterminado es False.

validateOnFocusIn

Ejecute la validación cuando se centre PropertyPaneTextField.

validateOnFocusIn?: boolean;

Valor de propiedad

boolean

Comentarios

El valor predeterminado es False.

validateOnFocusOut

Ejecute la validación cuando PropertyPaneTextField esté fuera de foco o en desenfoque.

validateOnFocusOut?: boolean;

Valor de propiedad

boolean

Comentarios

El valor predeterminado es False.

value

Valor que se mostrará en el campo de texto cuando el valor de targetProperty en el contenedor de propiedades del manifiesto esté vacío o contenga un valor NULL.

value?: string;

Valor de propiedad

string