element-ui

  • Version 2.15.14
  • Published
  • 9.25 MB
  • 6 dependencies
  • MIT license

Install

npm i element-ui
yarn add element-ui
pnpm add element-ui

Overview

A Component Library for Vue.js.

Index

Variables

Functions

Classes

Interfaces

Type Aliases

Namespaces

Variables

variable InfiniteScroll

const InfiniteScroll: PluginObject<ElInfiniteScroll>;
  • InfiniteScroll Directive

variable Loading

const Loading: ElLoading;
  • Show animation while loading data

variable Message

const Message: ElMessage;
  • Used to show feedback after an activity. The difference with Notification is that the latter is often used to show a system level passive notification.

variable MessageBox

const MessageBox: ElMessageBox;
  • A set of modal boxes simulating system message box, mainly for message prompt, success tips, error messages and query information

variable Notification

const Notification: ElNotification;
  • Displays a global notification message at the upper right corner of the page

variable version

const version: string;
  • The version of element-ui

Functions

function install

install: (vue: any, options: InstallationOptions) => void;
  • Install all element-ui components into Vue. Please do not invoke this method directly. Call Vue.use(ElementUI) to install.

Classes

class Alert

class Alert extends ElAlert {}
  • Alert Component

class Aside

class Aside extends ElAside {}
  • Aside Component

class Autocomplete

class Autocomplete extends ElAutocomplete {}
  • Autocomplete Component

class Avatar

class Avatar extends ElAvatar {}
  • Avatar Component

class Backtop

class Backtop extends ElBacktop {}
  • Backtop Component

class Badge

class Badge extends ElBadge {}
  • Bagde Component

class Breadcrumb extends ElBreadcrumb {}
  • Breadcrumb Component

class BreadcrumbItem extends ElBreadcrumbItem {}
  • Breadcrumb Item Component

class Button

class Button extends ElButton {}
  • Button Component

class ButtonGroup

class ButtonGroup extends ElButtonGroup {}
  • Button Group Component

class Calendar

class Calendar extends ElCalendar {}
  • Calendar Component

class Card

class Card extends ElCard {}
  • Card Component

class Carousel extends ElCarousel {}
  • Carousel Component

class CarouselItem

class CarouselItem extends ElCarouselItem {}
  • Carousel Item Component

class Cascader

class Cascader extends ElCascader {}
  • Cascader Component

class CascaderPanel

class CascaderPanel extends ElCascaderPanel {}
  • CascaderPanel Component

class Checkbox

class Checkbox extends ElCheckbox {}
  • Checkbox Component

class CheckboxButton

class CheckboxButton extends ElCheckboxButton {}
  • Checkbox Button Component

class CheckboxGroup

class CheckboxGroup extends ElCheckboxGroup {}
  • Checkbox Group Component

class Col

class Col extends ElCol {}
  • Colunm Layout Component

class Collapse

class Collapse extends ElCollapse {}
  • Collapse Component

class CollapseItem

class CollapseItem extends ElCollapseItem {}
  • Collapse Item Component

class ColorPicker

class ColorPicker extends ElColorPicker {}
  • Color Picker Component

class Container

class Container extends ElContainer {}
  • Container Component

class DatePicker

class DatePicker extends ElDatePicker {}
  • Date Picker Component

class Descriptions

class Descriptions extends ElDescriptions {}
  • Description Component

class DescriptionsItem

class DescriptionsItem extends ElDescriptionsItem {}
  • Description Item Component

class Dialog

class Dialog extends ElDialog {}
  • Dialog Component

class Divider

class Divider extends ElDivider {}
  • Divider Component

class Drawer

class Drawer extends ElDrawer {}
  • Drawer Component

class Dropdown extends ElDropdown {}
  • Dropdown Component

class DropdownItem extends ElDropdownItem {}
  • Dropdown Item Component

class DropdownMenu extends ElDropdownMenu {}
  • Dropdown Menu Component

class Empty

class Empty extends ElEmpty {}
  • Empty Component

class Footer extends ElFooter {}
  • Footer Component

class Form

class Form extends ElForm {}
  • Form Component

class FormItem

class FormItem extends ElFormItem {}
  • Form Item Component

class Header extends ElHeader {}
  • Header Component

class Icon

class Icon extends ElIcon {}
  • Icon Component

class Image

class Image extends ElImage {}
  • Image Component

class Input

class Input extends ElInput {}
  • Input Component

class InputNumber

class InputNumber extends ElInputNumber {}
  • Input Number Component

class Link extends ElLink {}
  • Link Component

class Main

class Main extends ElMain {}
  • Main Component

class Menu extends ElMenu {}
  • Menu that provides navigation for your website

class MenuItem extends ElMenuItem {}
  • Menu Item Component

class MenuItemGroup extends ElMenuItemGroup {}
  • Menu Item Group Component

class Option

class Option extends ElOption {}
  • Dropdown Select Option Component

class OptionGroup

class OptionGroup extends ElOptionGroup {}
  • Dropdown Select Option Group Component

class PageHeader extends ElPageHeader {}
  • PageHeader Component

class Pagination

class Pagination extends ElPagination {}
  • Pagination Component

class Popconfirm

class Popconfirm extends ElPopconfirm {}
  • Popconfirm Component

class Popover

class Popover extends ElPopover {}
  • Popover Component

class Progress

class Progress extends ElProgress {}
  • Progress Component

class Radio

class Radio extends ElRadio {}
  • Radio Component

class RadioButton

class RadioButton extends ElRadioButton {}
  • Radio Button Component

class RadioGroup

class RadioGroup extends ElRadioGroup {}
  • Radio Group Component

class Rate

class Rate extends ElRate {}
  • Rate Component

class Result

class Result extends ElResult {}
  • Result Component

class Row

class Row extends ElRow {}
  • Row Layout Component

class Select

class Select extends ElSelect {}
  • Dropdown Select Component

class Skeleton

class Skeleton extends ElSkeleton {}
  • Skeleton Component

class SkeletonItem

class SkeletonItem extends ElSkeletonItem {}
  • Skeleton Item Component

class Slider

class Slider extends ElSlider {}
  • Slider Component

class Spinner

class Spinner extends ElSpinner {}
  • Spinner Component

class Statistic

class Statistic extends ElStatistic {}
  • Statistic Component

class Step

class Step extends ElStep {}
  • Step Component

class Steps

class Steps extends ElSteps {}
  • Steps Component

class Submenu extends ElSubmenu {}
  • Submenu Component

class Switch

class Switch extends ElSwitch {}
  • Switch Component

class Table

class Table extends ElTable {}
  • Table Component

class TableColumn

class TableColumn extends ElTableColumn {}
  • Table Column Component

class TabPane

class TabPane extends ElTabPane {}
  • Tab Pane Component

class Tabs

class Tabs extends ElTabs {}
  • Tabs Component

class Tag

class Tag extends ElTag {}
  • Tag Component

class Timeline

class Timeline extends ElTimeline {}
  • Timeline Component

class TimelineItem

class TimelineItem extends ElTimelineItem {}
  • Timeline Item Component

class TimePicker

class TimePicker extends ElTimePicker {}
  • TimePicker Component

class TimeSelect

class TimeSelect extends ElTimeSelect {}
  • TimeSelect Component

class Tooltip

class Tooltip extends ElTooltip {}
  • Tooltip Component

class Transfer

class Transfer extends ElTransfer {}
  • Transfer Component

class Tree

class Tree<K = any, D = TreeData> extends ElTree<K, D> {}
  • Tree Component

class Upload

class Upload extends ElUpload {}
  • Upload Component

Interfaces

interface InstallationOptions

interface InstallationOptions {}

    property i18n

    i18n: any;

      property locale

      locale: any;

        property size

        size: string;

          Type Aliases

          type Component

          type Component = ElementUIComponent;
          • ElementUI component common definition

          type ComponentSize

          type ComponentSize = ElementUIComponentSize;
          • Component size definition for button, input, etc

          type HorizontalAlignment

          type HorizontalAlignment = ElementUIHorizontalAlignment;
          • Horizontal alignment

          Namespaces

          namespace default

          module 'types/element-ui.d.ts' {}
          • The version of element-ui

          variable InfiniteScroll

          const InfiniteScroll: PluginObject<ElInfiniteScroll>;
          • InfiniteScroll Directive

          variable Loading

          const Loading: ElLoading;
          • Show animation while loading data

          variable Message

          const Message: ElMessage;
          • Used to show feedback after an activity. The difference with Notification is that the latter is often used to show a system level passive notification.

          variable MessageBox

          const MessageBox: ElMessageBox;
          • A set of modal boxes simulating system message box, mainly for message prompt, success tips, error messages and query information

          variable Notification

          const Notification: ElNotification;
          • Displays a global notification message at the upper right corner of the page

          variable version

          const version: string;
          • The version of element-ui

          function install

          install: (vue: any, options: InstallationOptions) => void;
          • Install all element-ui components into Vue. Please do not invoke this method directly. Call Vue.use(ElementUI) to install.

          class Alert

          class Alert extends ElAlert {}
          • Alert Component

          class Aside

          class Aside extends ElAside {}
          • Aside Component

          class Autocomplete

          class Autocomplete extends ElAutocomplete {}
          • Autocomplete Component

          class Avatar

          class Avatar extends ElAvatar {}
          • Avatar Component

          class Backtop

          class Backtop extends ElBacktop {}
          • Backtop Component

          class Badge

          class Badge extends ElBadge {}
          • Bagde Component

          class Breadcrumb

          class Breadcrumb extends ElBreadcrumb {}
          • Breadcrumb Component

          class BreadcrumbItem

          class BreadcrumbItem extends ElBreadcrumbItem {}
          • Breadcrumb Item Component

          class Button

          class Button extends ElButton {}
          • Button Component

          class ButtonGroup

          class ButtonGroup extends ElButtonGroup {}
          • Button Group Component

          class Calendar

          class Calendar extends ElCalendar {}
          • Calendar Component

          class Card

          class Card extends ElCard {}
          • Card Component

          class Carousel

          class Carousel extends ElCarousel {}
          • Carousel Component

          class CarouselItem

          class CarouselItem extends ElCarouselItem {}
          • Carousel Item Component

          class Cascader

          class Cascader extends ElCascader {}
          • Cascader Component

          class CascaderPanel

          class CascaderPanel extends ElCascaderPanel {}
          • CascaderPanel Component

          class Checkbox

          class Checkbox extends ElCheckbox {}
          • Checkbox Component

          class CheckboxButton

          class CheckboxButton extends ElCheckboxButton {}
          • Checkbox Button Component

          class CheckboxGroup

          class CheckboxGroup extends ElCheckboxGroup {}
          • Checkbox Group Component

          class Col

          class Col extends ElCol {}
          • Colunm Layout Component

          class Collapse

          class Collapse extends ElCollapse {}
          • Collapse Component

          class CollapseItem

          class CollapseItem extends ElCollapseItem {}
          • Collapse Item Component

          class ColorPicker

          class ColorPicker extends ElColorPicker {}
          • Color Picker Component

          class Container

          class Container extends ElContainer {}
          • Container Component

          class DatePicker

          class DatePicker extends ElDatePicker {}
          • Date Picker Component

          class Descriptions

          class Descriptions extends ElDescriptions {}
          • Description Component

          class DescriptionsItem

          class DescriptionsItem extends ElDescriptionsItem {}
          • Description Item Component

          class Dialog

          class Dialog extends ElDialog {}
          • Dialog Component

          class Divider

          class Divider extends ElDivider {}
          • Divider Component

          class Drawer

          class Drawer extends ElDrawer {}
          • Drawer Component

          class Dropdown

          class Dropdown extends ElDropdown {}
          • Dropdown Component

          class DropdownItem

          class DropdownItem extends ElDropdownItem {}
          • Dropdown Item Component

          class DropdownMenu

          class DropdownMenu extends ElDropdownMenu {}
          • Dropdown Menu Component

          class Empty

          class Empty extends ElEmpty {}
          • Empty Component

          class Footer

          class Footer extends ElFooter {}
          • Footer Component

          class Form

          class Form extends ElForm {}
          • Form Component

          class FormItem

          class FormItem extends ElFormItem {}
          • Form Item Component

          class Header

          class Header extends ElHeader {}
          • Header Component

          class Icon

          class Icon extends ElIcon {}
          • Icon Component

          class Image

          class Image extends ElImage {}
          • Image Component

          class Input

          class Input extends ElInput {}
          • Input Component

          class InputNumber

          class InputNumber extends ElInputNumber {}
          • Input Number Component

          class Link extends ElLink {}
          • Link Component

          class Main

          class Main extends ElMain {}
          • Main Component

          class Menu

          class Menu extends ElMenu {}
          • Menu that provides navigation for your website

          class MenuItem

          class MenuItem extends ElMenuItem {}
          • Menu Item Component

          class MenuItemGroup

          class MenuItemGroup extends ElMenuItemGroup {}
          • Menu Item Group Component

          class Option

          class Option extends ElOption {}
          • Dropdown Select Option Component

          class OptionGroup

          class OptionGroup extends ElOptionGroup {}
          • Dropdown Select Option Group Component

          class PageHeader

          class PageHeader extends ElPageHeader {}
          • PageHeader Component

          class Pagination

          class Pagination extends ElPagination {}
          • Pagination Component

          class Popconfirm

          class Popconfirm extends ElPopconfirm {}
          • Popconfirm Component

          class Popover

          class Popover extends ElPopover {}
          • Popover Component

          class Progress

          class Progress extends ElProgress {}
          • Progress Component

          class Radio

          class Radio extends ElRadio {}
          • Radio Component

          class RadioButton

          class RadioButton extends ElRadioButton {}
          • Radio Button Component

          class RadioGroup

          class RadioGroup extends ElRadioGroup {}
          • Radio Group Component

          class Rate

          class Rate extends ElRate {}
          • Rate Component

          class Result

          class Result extends ElResult {}
          • Result Component

          class Row

          class Row extends ElRow {}
          • Row Layout Component

          class Select

          class Select extends ElSelect {}
          • Dropdown Select Component

          class Skeleton

          class Skeleton extends ElSkeleton {}
          • Skeleton Component

          class SkeletonItem

          class SkeletonItem extends ElSkeletonItem {}
          • Skeleton Item Component

          class Slider

          class Slider extends ElSlider {}
          • Slider Component

          class Spinner

          class Spinner extends ElSpinner {}
          • Spinner Component

          class Statistic

          class Statistic extends ElStatistic {}
          • Statistic Component

          class Step

          class Step extends ElStep {}
          • Step Component

          class Steps

          class Steps extends ElSteps {}
          • Steps Component

          class Submenu

          class Submenu extends ElSubmenu {}
          • Submenu Component

          class Switch

          class Switch extends ElSwitch {}
          • Switch Component

          class Table

          class Table extends ElTable {}
          • Table Component

          class TableColumn

          class TableColumn extends ElTableColumn {}
          • Table Column Component

          class TabPane

          class TabPane extends ElTabPane {}
          • Tab Pane Component

          class Tabs

          class Tabs extends ElTabs {}
          • Tabs Component

          class Tag

          class Tag extends ElTag {}
          • Tag Component

          class Timeline

          class Timeline extends ElTimeline {}
          • Timeline Component

          class TimelineItem

          class TimelineItem extends ElTimelineItem {}
          • Timeline Item Component

          class TimePicker

          class TimePicker extends ElTimePicker {}
          • TimePicker Component

          class TimeSelect

          class TimeSelect extends ElTimeSelect {}
          • TimeSelect Component

          class Tooltip

          class Tooltip extends ElTooltip {}
          • Tooltip Component

          class Transfer

          class Transfer extends ElTransfer {}
          • Transfer Component

          class Tree

          class Tree<K = any, D = TreeData> extends ElTree<K, D> {}
          • Tree Component

          class Upload

          class Upload extends ElUpload {}
          • Upload Component

          interface InstallationOptions

          interface InstallationOptions {}

            property i18n

            i18n: any;

              property locale

              locale: any;

                property size

                size: string;

                  type Component

                  type Component = ElementUIComponent;
                  • ElementUI component common definition

                  type ComponentSize

                  type ComponentSize = ElementUIComponentSize;
                  • Component size definition for button, input, etc

                  type HorizontalAlignment

                  type HorizontalAlignment = ElementUIHorizontalAlignment;
                  • Horizontal alignment

                  Package Files (2)

                  Dependencies (6)

                  Dev Dependencies (74)

                  Peer Dependencies (1)

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/element-ui.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/element-ui)
                  • HTML
                    <a href="https://www.jsdocs.io/package/element-ui"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>