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

Refactor tree.load_data #780

Open
wants to merge 10 commits into
base: dev
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
2 changes: 0 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ collections:
- options/ondragstop.md
- options/onismovehandle.md
- options/onloadfailed.md
- options/onloading.md
- options/openedicon.md
- options/openfolderdelay.md
- options/rtl.md
Expand Down Expand Up @@ -88,7 +87,6 @@ collections:
- events/tree-dblclick.md
- events/tree-init.md
- events/tree-load-data.md
- events/tree-loading-data.md
- events/tree-move.md
- events/tree-refresh.md
- events/tree-open.md
Expand Down
10 changes: 8 additions & 2 deletions docs/_entries/events/tree-load-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,19 @@ title: tree.load_data
name: event-load-data
---

Called after data is loaded using ajax.
Called before data is loaded using ajax.

Attributes:

- `node`
- null when loading the whole tree
- a node when loading data for a sub tree

{% highlight js %}
$('#tree1').on(
'tree.load_data',
function(e) {
console.log(e.tree_data);
//
}
);
{% endhighlight %}
27 changes: 0 additions & 27 deletions docs/_entries/events/tree-loading-data.md

This file was deleted.

22 changes: 0 additions & 22 deletions docs/_entries/options/onloading.md

This file was deleted.

34 changes: 9 additions & 25 deletions src/dataLoader.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Node } from "./node";
import { DataFilter, OnLoadFailed, OnLoading } from "./jqtreeOptions";
import { DataFilter, OnLoadFailed } from "./jqtreeOptions";
import { LoadData, TriggerEvent } from "./jqtreeMethodTypes";

export type HandleFinishedLoading = () => void;
Expand All @@ -8,7 +8,6 @@ interface DataLoaderParams {
dataFilter?: DataFilter;
loadData: LoadData;
onLoadFailed?: OnLoadFailed;
onLoading?: OnLoading;
treeElement: HTMLElement;
triggerEvent: TriggerEvent;
}
Expand All @@ -17,22 +16,19 @@ export default class DataLoader {
private dataFilter?: DataFilter;
private loadData: LoadData;
private onLoadFailed?: OnLoadFailed;
private onLoading?: OnLoading;
private treeElement: HTMLElement;
private triggerEvent: TriggerEvent;

constructor({
dataFilter,
loadData,
onLoadFailed,
onLoading,
treeElement,
triggerEvent,
}: DataLoaderParams) {
this.dataFilter = dataFilter;
this.loadData = loadData;
this.onLoadFailed = onLoadFailed;
this.onLoading = onLoading;
this.treeElement = treeElement;
this.triggerEvent = triggerEvent;
}
Expand All @@ -48,11 +44,13 @@ export default class DataLoader {

const element = this.getDomElement(parentNode);
this.addLoadingClass(element);
this.notifyLoading(true, parentNode, element);

this.triggerEvent("tree.load_data", {
node: parentNode,
});

const stopLoading = (): void => {
this.removeLoadingClass(element);
this.notifyLoading(false, parentNode, element);
};

const handleSuccess = (data: string | NodeData[]): void => {
Expand All @@ -62,6 +60,10 @@ export default class DataLoader {
if (onFinished && typeof onFinished === "function") {
onFinished();
}

this.triggerEvent("tree.loaded_data", {
node: parentNode,
});
};

const handleError = (jqXHR: JQuery.jqXHR): void => {
Expand Down Expand Up @@ -91,24 +93,6 @@ export default class DataLoader {
}
}

private notifyLoading(
isLoading: boolean,
node: Node | null,
element: HTMLElement,
): void {
const $el = jQuery(element);

if (this.onLoading) {
this.onLoading(isLoading, node, $el);
}

this.triggerEvent("tree.loading_data", {
isLoading,
node,
$el,
});
}

private submitRequest(
urlInfoInput: string | JQuery.AjaxSettings,
handleSuccess: JQuery.Ajax.SuccessCallback<any>,
Expand Down
7 changes: 0 additions & 7 deletions src/jqtreeOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,6 @@ export type IconElement = string | HTMLElement | JQuery<HTMLElement>;

export type OnCreateLi = (node: Node, el: JQuery, isSelected: boolean) => void;

export type OnLoading = (
isLoading: boolean,
node: Node | null,
$el: JQuery,
) => void;

export interface JQTreeOptions {
animationSpeed: JQuery.Duration;
autoEscape: boolean;
Expand All @@ -55,7 +49,6 @@ export interface JQTreeOptions {
onGetStateFromStorage?: OnGetStateFromStorage;
onIsMoveHandle?: OnIsMoveHandle;
onLoadFailed?: OnLoadFailed;
onLoading?: OnLoading;
onSetStateFromStorage?: OnSetStateFromStorage;
openedIcon?: IconElement;
openFolderDelay: number | false;
Expand Down
Loading
Loading