Ant Design Pass-Through
@vef-framework-react/components re-exports most of Ant Design directly. These components carry no VEF-specific behavior or prop changes — import them from @vef-framework-react/components and use them exactly as documented on the Ant Design site.
Of the components with their own pages,
Modal(addsdraggable),Table(addsflexHeight/striped), andUpload(addsenableCrop/pastable) genuinely extend antd.Button,Input,Alert,Avatar,Typography,Compact, andBorderBeamare bareantdre-exports too — they get dedicated pages for discoverability, not because VEF changes their behavior.Emptyin the table below is also not an unmodified pass-through: VEF overrides its defaultimageto antd'sPRESENTED_IMAGE_SIMPLE. For components that genuinely gain VEF-specific props, hooks, or behavior, or that are VEF-original, see the Components Overview.
import { Affix, Card, Tabs, Tag } from '@vef-framework-react/components';
| Component | Description | Ant Design docs |
|---|---|---|
Affix | Stick an element to the viewport. | Affix |
Anchor | Hyperlinks to sections on a page. | Anchor |
AutoComplete | An input with autocomplete suggestions. | AutoComplete |
Badge | Displays a count or status on an element. | Badge |
Breadcrumb | Shows the current page location within a hierarchy. | Breadcrumb |
Calendar | Displays dates in a calendar format. | Calendar |
Card | A container for grouping related content. | Card |
Carousel | A slideshow cycling through elements. | Carousel |
Cascader | Select from a hierarchical list of options. | Cascader |
Checkbox | A checkbox for selecting multiple options. | Checkbox |
Col | A grid column container. | Col |
Collapse | Collapsible content sections. | Collapse |
ColorPicker | A color picker input. | ColorPicker |
DatePicker | Select a date or date range. | DatePicker |
Descriptions | Display multiple read-only fields in groups. | Descriptions |
Divider | A visual divider between content. | Divider |
Drawer | A panel that slides in from the edge. | Drawer |
Dropdown | A dropdown menu triggered by a button. | Dropdown |
Empty | An empty-state placeholder; VEF presets image to PRESENTED_IMAGE_SIMPLE. | Empty |
Flex | A flex layout container. | Flex |
FloatButton | A floating action button. | FloatButton |
Image | An image with preview support. | Image |
InputNumber | A numeric input field. | InputNumber |
List | Display a list of items. | List |
Mentions | Mention someone in a text input. | Mentions |
Menu | A navigation menu for page routing. | Menu |
Pagination | Pagination control for long lists. | Pagination |
Popconfirm | A confirmation popover on an element. | Popconfirm |
Popover | A floating card triggered by click. | Popover |
Progress | Display the current progress of an operation. | Progress |
QRCode | Generate a QR code. | QRCode |
Radio | Select a single option from a group. | Radio |
Rate | A star rating component. | Rate |
Result | Show the result of an operation. | Result |
Row | A grid row container. | Row |
Segmented | A segmented control for switching views. | Segmented |
Skeleton | A placeholder while content is loading. | Skeleton |
Slider | A slider for selecting a value in a range. | Slider |
Space | Set spacing between components. | Space |
Spin | A loading spinner. | Spin |
Splitter | Resizable split panels. | Splitter |
Statistic | Display a statistic value. | Statistic |
Steps | A step-by-step progress indicator. | Steps |
Switch | A toggle switch. | Switch |
Tabs | Organize content into tabbed sections. | Tabs |
Tag | A label for categorizing content. | Tag |
TimePicker | Select a time value. | TimePicker |
Timeline | Display a list of events in chronological order. | Timeline |
Tooltip | A simple text popup on hover. | Tooltip |
Tour | A guided tour of UI elements. | Tour |
Transfer | Move items between two lists. | Transfer |
Watermark | Add a watermark to a container. | Watermark |
Types
Every component above re-exports its props type under antd's own name — AffixProps, AnchorProps, AutoCompleteProps, BadgeProps, BreadcrumbProps, CalendarProps, CardProps, CarouselProps, CascaderProps, CheckboxProps, ColProps, CollapseProps, ColorPickerProps, DatePickerProps, DescriptionsProps, DividerProps, DrawerProps, DropdownProps, EmptyProps, FlexProps, FloatButtonProps, ImageProps, InputNumberProps, ListProps, MentionsProps, MenuProps, PaginationProps, PopconfirmProps, PopoverProps, ProgressProps, QRCodeProps, RadioProps, RateProps, ResultProps, RowProps, SegmentedProps, SkeletonProps, SliderProps, SpaceProps, SpinProps, SplitterProps, StatisticProps, StepsProps, SwitchProps, TabsProps, TagProps, TimePickerProps, TimelineProps, TooltipProps, TourProps, TransferProps, WatermarkProps — and so do the parts it is built from: AvatarGroupProps, BadgeRibbonProps, CardGridProps / CardMetaProps, CheckableTagProps, CheckboxGroupProps, RadioGroupProps, DropdownButtonProps, ListItemProps / ListItemMetaProps, SkeletonButtonProps / SkeletonImageProps / SkeletonInputProps / SkeletonNodeProps / SkeletonParagraphProps / SkeletonTitleProps, SliderSingleProps / SliderRangeProps, StatisticTimerProps, TimeRangePickerProps, and DateRangePickerProps / MonthPickerProps / WeekPickerProps (DatePicker.RangePicker / .MonthPicker / .WeekPicker). The same holds for the components with their own pages — InputProps with PasswordProps / SearchProps / TextAreaProps / OTPProps, the Typography parts' TitleProps / ParagraphProps / TextProps / LinkProps, AlertProps, AvatarProps, CompactProps.
The configuration shapes have named aliases, so a host does not have to dig them out of antd's internals:
| Type | What it is |
|---|---|
AnchorLinkItem | An Anchor items entry |
AutoCompleteOption | An AutoComplete options entry |
BreadcrumbItem | A Breadcrumb items entry; BreadcrumbItemType / BreadcrumbSeparatorType are its two kinds |
CarouselDotPlacement / CarouselEffect / CarouselRef | Carousel's dot placement, transition effect, and ref |
CascaderOption | A Cascader options entry |
CheckboxOption<T> / RadioOption<T> | A Checkbox.Group / Radio.Group options entry |
CollapseItem | A Collapse items entry |
DescriptionsItem | A Descriptions items entry |
DropdownMenuProps / DropdownMenuItem | Dropdown's menu prop and one of its items; DropdownButtonType is Dropdown.Button's type |
InputRef / TooltipRef | The refs of Input and Tooltip |
ListGridType | List's grid prop |
MentionsOption | A Mentions options entry |
MenuItemType / SubMenuType / MenuItemGroupType / MenuDividerType | The four kinds of Menu items entry |
SegmentedOption<T> | A Segmented options entry |
TimelineItem | A Timeline items entry |
TourStep | A Tour steps entry |
TransferItem | A Transfer dataSource record |