Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: Convenient methods for getting component type instances #712

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions content/getting-started/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,13 @@ If you provide the wrong category or ID then the console will give you a warning

If you have provided the correct category and element ID then you can now access the object as if you've created it yourself and work with it programmatically via JavaScript:

Convenient methods exist for getting the instance objects of each component type:

```javascript
const modal = FlowbiteInstances.getModal('modal-id');
const tooltip = FlowbiteInstances.getTooltip('tooltip-id');
```

```javascript
// show the modal
modal.show();
Expand Down Expand Up @@ -285,6 +292,8 @@ Alternatively, you can also get all of the instances from one component pool suc

```javascript
FlowbiteInstance.getInstances('Modal');
// or
FlowbiteInstance.getModalList();
```

## Instance options
Expand Down
15 changes: 3 additions & 12 deletions src/components/drawer/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -342,10 +342,7 @@ export function initDrawers() {
const $drawerEl = document.getElementById(drawerId);

if ($drawerEl) {
const drawer: DrawerInterface = instances.getInstance(
'Drawer',
drawerId
);
const drawer: DrawerInterface = instances.getDrawer(drawerId);

if (drawer) {
const toggleDrawer = () => {
Expand Down Expand Up @@ -378,10 +375,7 @@ export function initDrawers() {
const $drawerEl = document.getElementById(drawerId);

if ($drawerEl) {
const drawer: DrawerInterface = instances.getInstance(
'Drawer',
drawerId
);
const drawer: DrawerInterface = instances.getDrawer(drawerId);

if (drawer) {
const hideDrawer = () => {
Expand Down Expand Up @@ -410,10 +404,7 @@ export function initDrawers() {
const $drawerEl = document.getElementById(drawerId);

if ($drawerEl) {
const drawer: DrawerInterface = instances.getInstance(
'Drawer',
drawerId
);
const drawer: DrawerInterface = instances.getDrawer(drawerId);

if (drawer) {
const showDrawer = () => {
Expand Down
15 changes: 3 additions & 12 deletions src/components/modal/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -295,10 +295,7 @@ export function initModals() {
const $modalEl = document.getElementById(modalId);

if ($modalEl) {
const modal: ModalInterface = instances.getInstance(
'Modal',
modalId
);
const modal: ModalInterface = instances.getModal(modalId);

if (modal) {
const toggleModal = () => {
Expand Down Expand Up @@ -328,10 +325,7 @@ export function initModals() {
const $modalEl = document.getElementById(modalId);

if ($modalEl) {
const modal: ModalInterface = instances.getInstance(
'Modal',
modalId
);
const modal: ModalInterface = instances.getModal(modalId);

if (modal) {
const showModal = () => {
Expand Down Expand Up @@ -361,10 +355,7 @@ export function initModals() {
const $modalEl = document.getElementById(modalId);

if ($modalEl) {
const modal: ModalInterface = instances.getInstance(
'Modal',
modalId
);
const modal: ModalInterface = instances.getModal(modalId);

if (modal) {
const hideModal = () => {
Expand Down
88 changes: 88 additions & 0 deletions src/dom/instances.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,50 @@ class Instances {
return this._instances[component];
}

getModalList() {
return this.getInstances('Modal');
}

getAccordionList() {
return this.getInstances('Accordion');
}

getCarouselList() {
return this.getInstances('Carousel');
}

getCollapseList() {
return this.getInstances('Collapse');
}

getDialList() {
return this.getInstances('Dial');
}

getDismissList() {
return this.getInstances('Dismiss');
}

getDrawerList() {
return this.getInstances('Drawer');
}

getDropdownList() {
return this.getInstances('Dropdown');
}

getPopoverList() {
return this.getInstances('Popover');
}

getTabsList() {
return this.getInstances('Tabs');
}

getTooltipList() {
return this.getInstances('Tooltip');
}

getInstance(component: keyof Instances['_instances'], id: string) {
if (!this._componentAndInstanceCheck(component, id)) {
return;
Expand All @@ -89,6 +133,50 @@ class Instances {
return this._instances[component][id] as any;
}

getModal(id: string): undefined|ModalInterface {
return this.getInstance('Modal', id);
}

getAccordion(id: string): undefined|AccordionInterface {
return this.getInstance('Accordion', id);
}

getCarousel(id: string): undefined|CarouselInterface {
return this.getInstance('Carousel', id);
}

getCollapse(id: string): undefined|CollapseInterface {
return this.getInstance('Collapse', id);
}

getDial(id: string): undefined|DialInterface {
return this.getInstance('Dial', id);
}

getDismiss(id: string): undefined|DismissInterface {
return this.getInstance('Dismiss', id);
}

getDrawer(id: string): undefined|DrawerInterface {
return this.getInstance('Drawer', id);
}

getDropdown(id: string): undefined|DropdownInterface {
return this.getInstance('Dropdown', id);
}

getPopover(id: string): undefined|PopoverInterface {
return this.getInstance('Popover', id);
}

getTabs(id: string): undefined|TabsInterface {
return this.getInstance('Tabs', id);
}

getTooltip(id: string): undefined|TooltipInterface {
return this.getInstance('Tooltip', id);
}

destroyAndRemoveInstance(
component: keyof Instances['_instances'],
id: string
Expand Down