Back to Beekeeper Studio

Entity List API

apps/ui-kit/docs/api/entity-list.md

5.7.22.6 KB
Original Source

Entity List API

For examples and usage details, visit Entity List page.

Properties

NameTypeDescriptionDefault
entitiesobject[]An array of entities. See Entity API for more details.[]
hiddenEntitiesobject[]An array of hidden entities. See Entity API for more details.[]
contextMenuItemsobject[] | functionExtend the default context menu. See Context Menu for more details.undefined

Events

NameDescriptionEvent Detail
bks-entity-expandEmitted when an entity is expanded.{ entity: Entity }
bks-entity-collapseEmitted when an entity is collapsed.{ entity: Entity }
bks-entity-dblclickEmitted when an entity is double-clicked.{ event: MouseEvent, entity: Entity }
bks-entity-contextmenuEmitted when an entity is right-clicked.{ event: MouseEvent, entity: Entity }
bks-entities-request-columnsEmitted when expanding an entity and its columns is undefined.{ entity: Entity }
bks-expand-allEmitted when clicking the expand all button and all entities are expanded.-
bks-collapse-allEmitted when clicking the collapse all button and all entities are collapsed.-
bks-add-entity-clickEmitted when the add entity button is clicked.{ event: MouseEvent }
bks-refresh-clickEmitted when the refresh button is clicked.{ event: MouseEvent }