mirror of
https://github.com/Redocly/redoc.git
synced 2025-03-05 18:35:49 +03:00
Adapt menu service and lazy-tasks to new menu strcuture
This commit is contained in:
parent
398aa60a46
commit
97949a17f9
|
@ -5,9 +5,12 @@ import { BehaviorSubject } from 'rxjs/BehaviorSubject';
|
|||
import { ScrollService, INVIEW_POSITION } from './scroll.service';
|
||||
import { Hash } from './hash.service';
|
||||
import { SpecManager } from '../utils/spec-manager';
|
||||
import { SchemaHelper, MenuCategory } from './schema-helper.service';
|
||||
import { SchemaHelper, MenuItem } from './schema-helper.service';
|
||||
import { AppStateService } from './app-state.service';
|
||||
import { LazyTasksService } from '../shared/components/LazyFor/lazy-for';
|
||||
import { JsonPointer } from '../utils/JsonPointer';
|
||||
import * as slugify from 'slugify';
|
||||
|
||||
|
||||
const CHANGE = {
|
||||
NEXT : 1,
|
||||
|
@ -20,11 +23,14 @@ export class MenuService {
|
|||
|
||||
changed: EventEmitter<any> = new EventEmitter();
|
||||
ready: BehaviorSubject<boolean> = new BehaviorSubject(false);
|
||||
categories: Array<MenuCategory>;
|
||||
items: Array<MenuItem>;
|
||||
flatItems: Array<MenuItem>;
|
||||
|
||||
activeCatIdx: number = 0;
|
||||
activeMethodIdx: number = -1;
|
||||
|
||||
activeIdx: number = -1;
|
||||
|
||||
private _hashSubscription: Subscription;
|
||||
|
||||
constructor(
|
||||
|
@ -35,20 +41,19 @@ export class MenuService {
|
|||
specMgr:SpecManager
|
||||
) {
|
||||
this.hash = hash;
|
||||
this.categories = SchemaHelper.buildMenuTree(specMgr.schema);
|
||||
this.items = SchemaHelper.buildMenuTree(specMgr.schema);
|
||||
this.flatItems = SchemaHelper.flatMenu(this.items);
|
||||
|
||||
scrollService.scroll.subscribe((evt) => {
|
||||
this.scrollUpdate(evt.isScrolledDown);
|
||||
});
|
||||
|
||||
//this.changeActive(CHANGE.INITIAL);
|
||||
|
||||
this._hashSubscription = this.hash.value.subscribe((hash) => {
|
||||
if (hash == undefined) return;
|
||||
this.setActiveByHash(hash);
|
||||
if (!this.tasks.empty) {
|
||||
this.tasks.start(this.activeCatIdx, this.activeMethodIdx, this);
|
||||
this.scrollService.setStickElement(this.getCurrentMethodEl());
|
||||
this.tasks.start(this.activeIdx, this);
|
||||
this.scrollService.setStickElement(this.getCurrentEl());
|
||||
if (hash) this.scrollToActive();
|
||||
this.appState.stopLoading();
|
||||
} else {
|
||||
|
@ -57,45 +62,39 @@ export class MenuService {
|
|||
});
|
||||
}
|
||||
|
||||
enableItem(catIdx, methodIdx, skipUpdate = false) {
|
||||
let cat = this.categories[catIdx];
|
||||
cat.ready = true;
|
||||
if (cat.methods.length) cat.methods[methodIdx].ready = true;
|
||||
let prevCat = this.categories[catIdx - 1];
|
||||
if (prevCat && !prevCat.ready && (prevCat.virtual || !prevCat.methods.length)) {
|
||||
this.enableItem(catIdx - 1, -1, true);
|
||||
enableItem(idx) {
|
||||
let item = this.flatItems[idx];
|
||||
item.ready = true;
|
||||
if (item.parent) {
|
||||
item.parent.ready = true;
|
||||
idx = item.parent.flatIdx;
|
||||
}
|
||||
|
||||
let prevItem = this.flatItems[idx -= 1];
|
||||
while(prevItem && (!prevItem.metadata || !prevItem.items)) {
|
||||
prevItem.ready = true;
|
||||
prevItem = this.flatItems[idx -= 1];
|
||||
}
|
||||
|
||||
if (skipUpdate) return;
|
||||
this.changed.next();
|
||||
}
|
||||
|
||||
get activeMethodPtr() {
|
||||
let cat = this.categories[this.activeCatIdx];
|
||||
let ptr = null;
|
||||
if (cat && cat.methods.length) {
|
||||
let mtd = cat.methods[this.activeMethodIdx];
|
||||
ptr = mtd && mtd.pointer || null;
|
||||
}
|
||||
return ptr;
|
||||
}
|
||||
|
||||
scrollUpdate(isScrolledDown) {
|
||||
let stable = false;
|
||||
while(!stable) {
|
||||
let $activeMethodHost = this.getCurrentMethodEl();
|
||||
if (!$activeMethodHost) return;
|
||||
var elementInViewPos = this.scrollService.getElementPos($activeMethodHost);
|
||||
if(isScrolledDown) {
|
||||
//&& elementInViewPos === INVIEW_POSITION.BELLOW
|
||||
let $nextEl = this.getRelativeCatOrItem(1);
|
||||
let $nextEl = this.getEl(this.activeIdx + 1);
|
||||
if (!$nextEl) return;
|
||||
let nextInViewPos = this.scrollService.getElementPos($nextEl, true);
|
||||
if (elementInViewPos === INVIEW_POSITION.BELLOW && nextInViewPos === INVIEW_POSITION.ABOVE) {
|
||||
if (nextInViewPos === INVIEW_POSITION.ABOVE) {
|
||||
stable = this.changeActive(CHANGE.NEXT);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
let $currentEl = this.getCurrentEl();
|
||||
if (!$currentEl) return;
|
||||
var elementInViewPos = this.scrollService.getElementPos($currentEl);
|
||||
if(!isScrolledDown && elementInViewPos === INVIEW_POSITION.ABOVE ) {
|
||||
stable = this.changeActive(CHANGE.BACK);
|
||||
continue;
|
||||
|
@ -104,133 +103,74 @@ export class MenuService {
|
|||
}
|
||||
}
|
||||
|
||||
getRelativeCatOrItem(offset: number = 0) {
|
||||
let ptr, cat;
|
||||
cat = this.categories[this.activeCatIdx];
|
||||
if (cat.methods.length === 0) {
|
||||
ptr = null;
|
||||
cat = this.categories[this.activeCatIdx + Math.sign(offset)] || cat;
|
||||
} else {
|
||||
let cat = this.categories[this.activeCatIdx];
|
||||
let idx = this.activeMethodIdx + offset;
|
||||
if ((idx >= cat.methods.length - 1) || idx < 0) {
|
||||
cat = this.categories[this.activeCatIdx + Math.sign(offset)] || cat;
|
||||
idx = offset > 0 ? -1 : cat.methods.length - 1;
|
||||
}
|
||||
ptr = cat.methods[idx] && cat.methods[idx].pointer;
|
||||
getEl(flatIdx) {
|
||||
if (flatIdx < 0) flatIdx = 0;
|
||||
let currentItem = this.flatItems[flatIdx];
|
||||
let selector = '';
|
||||
while(currentItem) {
|
||||
selector = `[section="${currentItem.id}"] ` + selector
|
||||
currentItem = currentItem.parent;
|
||||
}
|
||||
|
||||
return this.getMethodElByPtr(ptr, cat.id);
|
||||
selector = selector.trim();
|
||||
return selector ? document.querySelector(selector) : null;
|
||||
}
|
||||
|
||||
getCurrentMethodEl() {
|
||||
return this.getMethodElByPtr(this.activeMethodPtr,
|
||||
this.categories[this.activeCatIdx].id);
|
||||
getCurrentEl() {
|
||||
return this.getEl(this.activeIdx);
|
||||
}
|
||||
|
||||
getMethodElByPtr(ptr, section) {
|
||||
let selector = ptr ? `[pointer="${ptr}"][section="${section}"]` : `[section="${section}"]`;
|
||||
return document.querySelector(selector);
|
||||
deactivate(idx) {
|
||||
if (idx < 0) return;
|
||||
|
||||
let prevItem = this.flatItems[idx];
|
||||
prevItem.active = false;
|
||||
if (prevItem.parent) {
|
||||
prevItem.parent.active = false;
|
||||
}
|
||||
}
|
||||
|
||||
getMethodElByOperId(operationId) {
|
||||
let selector =`[operation-id="${operationId}"]`;
|
||||
return document.querySelector(selector);
|
||||
}
|
||||
activate(idx) {
|
||||
this.deactivate(this.activeIdx);
|
||||
this.activeIdx = idx;
|
||||
if (idx < 0) return;
|
||||
|
||||
activate(catIdx, methodIdx) {
|
||||
if (catIdx < 0) return;
|
||||
|
||||
let menu = this.categories;
|
||||
|
||||
menu[this.activeCatIdx].active = false;
|
||||
if (menu[this.activeCatIdx].methods.length) {
|
||||
if (this.activeMethodIdx >= 0) {
|
||||
menu[this.activeCatIdx].methods[this.activeMethodIdx].active = false;
|
||||
}
|
||||
}
|
||||
|
||||
this.activeCatIdx = catIdx;
|
||||
this.activeMethodIdx = methodIdx;
|
||||
menu[catIdx].active = true;
|
||||
let currentItem;
|
||||
if (menu[catIdx].methods.length && (methodIdx > -1)) {
|
||||
currentItem = menu[catIdx].methods[methodIdx];
|
||||
currentItem.active = true;
|
||||
let currentItem = this.flatItems[this.activeIdx];
|
||||
currentItem.active = true;
|
||||
if (currentItem.parent) {
|
||||
currentItem.parent.active = true;
|
||||
}
|
||||
|
||||
this.changed.next({cat: menu[catIdx], item: currentItem});
|
||||
}
|
||||
|
||||
_calcActiveIndexes(offset) {
|
||||
let menu = this.categories;
|
||||
let catCount = menu.length;
|
||||
if (!catCount) return [0, -1];
|
||||
let catLength = menu[this.activeCatIdx].methods.length;
|
||||
|
||||
let resMethodIdx = this.activeMethodIdx + offset;
|
||||
let resCatIdx = this.activeCatIdx;
|
||||
|
||||
if (resMethodIdx > catLength - 1) {
|
||||
resCatIdx++;
|
||||
resMethodIdx = -1;
|
||||
}
|
||||
if (resMethodIdx < -1) {
|
||||
let prevCatIdx = --resCatIdx;
|
||||
catLength = menu[Math.max(prevCatIdx, 0)].methods.length;
|
||||
resMethodIdx = catLength - 1;
|
||||
}
|
||||
if (resCatIdx > catCount - 1) {
|
||||
resCatIdx = catCount - 1;
|
||||
resMethodIdx = catLength - 1;
|
||||
}
|
||||
if (resCatIdx < 0) {
|
||||
resCatIdx = 0;
|
||||
resMethodIdx = 0;
|
||||
}
|
||||
|
||||
return [resCatIdx, resMethodIdx];
|
||||
this.changed.next(currentItem);
|
||||
}
|
||||
|
||||
changeActive(offset = 1) {
|
||||
let [catIdx, methodIdx] = this._calcActiveIndexes(offset);
|
||||
this.activate(catIdx, methodIdx);
|
||||
return (methodIdx === 0 && catIdx === 0);
|
||||
let noChange = (this.activeIdx <= 0 && offset === -1) ||
|
||||
(this.activeIdx === this.flatItems.length - 1 && offset === 1);
|
||||
this.activate(this.activeIdx + offset);
|
||||
return noChange;
|
||||
}
|
||||
|
||||
scrollToActive() {
|
||||
this.scrollService.scrollTo(this.getCurrentMethodEl());
|
||||
this.scrollService.scrollTo(this.getCurrentEl());
|
||||
}
|
||||
|
||||
setActiveByHash(hash) {
|
||||
if (!hash) {
|
||||
if (this.categories[0].headless) {
|
||||
this.activate(0, 0);
|
||||
}
|
||||
return;
|
||||
}
|
||||
let catIdx, methodIdx;
|
||||
if (!hash) return;
|
||||
let idx = 0;
|
||||
hash = hash.substr(1);
|
||||
let namespace = hash.split('/')[0];
|
||||
let ptr = decodeURIComponent(hash.substr(namespace.length + 1));
|
||||
if (namespace === 'section' || namespace === 'tag') {
|
||||
let sectionId = ptr.split('/')[0];
|
||||
catIdx = this.categories.findIndex(cat => cat.id === namespace + '/' + sectionId);
|
||||
let cat = this.categories[catIdx];
|
||||
ptr = ptr.substr(sectionId.length) || null;
|
||||
methodIdx = cat.methods.findIndex(method => method.pointer === ptr);
|
||||
} else {
|
||||
catIdx = this.categories.findIndex(cat => {
|
||||
if (!cat.methods.length) return false;
|
||||
methodIdx = cat.methods.findIndex(method => method.operationId === ptr || method.pointer === ptr);
|
||||
if (methodIdx >= 0) {
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
});
|
||||
let searchId = ptr || (namespace + '/' + sectionId);
|
||||
idx = this.flatItems.findIndex(item => item.id === searchId);
|
||||
} else if (namespace === 'operation') {
|
||||
idx = this.flatItems.findIndex(item => {
|
||||
return item.metadata && item.metadata.operationId === ptr
|
||||
})
|
||||
}
|
||||
this.activate(catIdx, methodIdx);
|
||||
this.activate(idx);
|
||||
}
|
||||
|
||||
destroy() {
|
||||
|
|
|
@ -51,8 +51,8 @@ export class LazyTasksService {
|
|||
}
|
||||
|
||||
addTasks(tasks:any[], callback:Function) {
|
||||
tasks.forEach((task) => {
|
||||
let taskCopy = Object.assign({_callback: callback}, task);
|
||||
tasks.forEach((task, idx) => {
|
||||
let taskCopy = Object.assign({_callback: callback, idx: idx}, task);
|
||||
this._tasks.push(taskCopy);
|
||||
});
|
||||
}
|
||||
|
@ -62,7 +62,7 @@ export class LazyTasksService {
|
|||
if (!task) return;
|
||||
task._callback(task.idx, true);
|
||||
this._current++;
|
||||
this.menuService.enableItem(task.catIdx, task.idx);
|
||||
this.menuService.enableItem(task.flatIdx);
|
||||
this.loadProgress.next(this._current / this._tasks.length * 100);
|
||||
}
|
||||
|
||||
|
@ -72,39 +72,30 @@ export class LazyTasksService {
|
|||
if (!task) return;
|
||||
task._callback(task.idx, false).then(() => {
|
||||
this._current++;
|
||||
this.menuService.enableItem(task.catIdx, task.idx);
|
||||
this.menuService.enableItem(task.flatIdx);
|
||||
setTimeout(()=> this.nextTask());
|
||||
this.loadProgress.next(this._current / this._tasks.length * 100);
|
||||
}).catch(err => console.error(err));
|
||||
});
|
||||
}
|
||||
|
||||
sortTasks(catIdx, metIdx) {
|
||||
sortTasks(center) {
|
||||
let idxMap = {};
|
||||
this._tasks.forEach((task, idx) => {
|
||||
idxMap[task.catIdx + '_' + task.idx] = idx;
|
||||
});
|
||||
metIdx = metIdx < 0 ? 0 : metIdx;
|
||||
let destIdx = idxMap[catIdx + '_' + metIdx] || 0;
|
||||
this._tasks.sort((a, b) => {
|
||||
let aIdx = idxMap[a.catIdx + '_' + a.idx];
|
||||
let bIdx = idxMap[b.catIdx + '_' + b.idx];
|
||||
return Math.abs(aIdx - destIdx) - Math.abs(bIdx - destIdx);
|
||||
return Math.abs(a.flatIdx - center) - Math.abs(b.flatIdx - center);
|
||||
})
|
||||
}
|
||||
|
||||
start(catIdx, metIdx, menuService) {
|
||||
start(idx, menuService) {
|
||||
this.menuService = menuService;
|
||||
let syncCount = 5;
|
||||
// I know this is bad practice to detect browsers but there is an issue on Safari only
|
||||
// I know this is a bad practice to detect browsers but there is an issue in Safari only
|
||||
// http://stackoverflow.com/questions/40692365/maintaining-scroll-position-while-inserting-elements-above-glitching-only-in-sa
|
||||
if (isSafari && this.optionsService.options.$scrollParent === window) {
|
||||
syncCount = (metIdx >= 0) ?
|
||||
this._tasks.findIndex(task => (task.catIdx === catIdx) && (task.idx === metIdx))
|
||||
: this._tasks.findIndex(task => task.catIdx === catIdx);
|
||||
syncCount = this._tasks.findIndex(task => task.idx === idx);
|
||||
syncCount += 1;
|
||||
} else {
|
||||
this.sortTasks(catIdx, metIdx);
|
||||
this.sortTasks(idx);
|
||||
}
|
||||
if (this.allSync) syncCount = this._tasks.length;
|
||||
for (var i = this._current; i < syncCount; i++) {
|
||||
|
@ -141,8 +132,8 @@ export class LazyFor {
|
|||
}
|
||||
|
||||
nextIteration(idx: number, sync: boolean):Promise<void> {
|
||||
const view = this._viewContainer.createEmbeddedView(
|
||||
this._template, new LazyForRow(this.lazyForOf[idx], idx, sync), idx < this.prevIdx ? 0 : undefined);
|
||||
const view = this._viewContainer.createEmbeddedView(this._template,
|
||||
new LazyForRow(this.lazyForOf[idx], idx, sync), idx < this.prevIdx ? 0 : undefined);
|
||||
this.prevIdx = idx;
|
||||
view.context.index = idx;
|
||||
(<any>view as ChangeDetectorRef).markForCheck();
|
||||
|
@ -165,6 +156,7 @@ export class LazyFor {
|
|||
}
|
||||
|
||||
ngOnInit() {
|
||||
if (!this.lazyForOf) return;
|
||||
this.lazyTasks.addTasks(this.lazyForOf, this.nextIteration.bind(this))
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue
Block a user