Skip to content

Component helpers ​

formUtil.validate(ref) and validateScrollToField(ref) resolve true on success. Since 2.0.16, invalid forms reject with Element Plus invalidFields rather than resolving false; catch the rejection. Unmounted instances reject with Error. FaForm.validate() without a callback and validateScrollToField() follow the same contract; validate(callback) retains native Element Plus callback behavior.

CategoryRuntime exportsPurpose
PropsfaAvatarProps、faButtonProps、faDialogProps、faDrawerProps、faFormProps、faFormItemProps、faFormItemTipProps、faIconProps、faImageProps、faInputDialogPageProps、faSelectProps、faSelectPageProps、faSelectV2Props、faTableProps、faTreeProps、faTreeSelectProps、faUploadProps、faUploadImageProps、faUploadImagesPropsReusable runtime prop definitions
EmitsfaAvatarEmits、faButtonEmits、faDialogEmits、faDrawerEmits、faFormEmits、faImageEmits、faInputDialogPageEmits、faSelectPageEmits、faTableEmits、faTreeEmits、faTreeSelectEmits、faUploadEmits、faUploadImageEmits、faUploadImagesEmitsReusable runtime emit validators
Native table definitionstableProps、tableColumnPropsElement Plus table prop baseline used by the wrapper
Table utilitiesPagedSearchTypeEnum、getTableDefaultSlots、formUtil、tableUtilPagination, slot data, and business table helpers
SelectorsSelectV2PropsReusable FaSelectV2 prop types and values
License platesCarNumberArea、CarNumberDigit、CarNumberLetterRegion, digit, and letter keyboard data

Public types include component Props, Emits, Slots, Instance, Exposes, DefaultRow, ElSelectorValue, ElSelectorModelValue, ElSelectorOutput, ElTreeValue, ElTreeOutput, FaLayoutGridBreakpoint, FaTableColumnCtx, FaTableSearchColumnCtx, PagedInput, and PagedResult. Generated root TypeScript declarations define exact fields, generics, and nullability.

Business data whose shape is unknown to the SDK defaults to any. Constrain known models with PagedResult<Output>, ElSelectorOutput<Value, Data>, or ElTreeOutput<Value, Data>. Unvalidated runtime input, errors, reflection results, and values requiring narrowing continue to use unknown.

getTableDefaultSlots Slots ​

Gets data and operations shared with the FaTable default slot.

Signature ​

ts
getTableDefaultSlots(state: FaTableState): FaTableDefaultSlotsResult;

Example ​

ts
import { getTableDefaultSlots } from "fast-element-plus";

const result = getTableDefaultSlots(tableState);

Input ​

InputTypeRequired / defaultDescription
stateFaTableStateRequiredTable state held by FaTable internals or a composition wrapper.

Returns ​

ValueTypeDescription
resultFaTableDefaultSlotsResultNew object containing loading, search, selection, and optional search operations.

Since 2.0.28, PagedInput declares optional readonly isOrderBy. The server computes whether default sorting applies from sortList, so paged requests may omit it.