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

Replace scroll-tracker mixin with class decorator #832

Open
wants to merge 2 commits 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
42 changes: 0 additions & 42 deletions app/mixins/scroll-tracker.js

This file was deleted.

5 changes: 3 additions & 2 deletions app/routes/project-version/classes/class.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ import { inject as service } from '@ember/service';
import { resolve, all } from 'rsvp';
import Route from '@ember/routing/route';
import { set } from '@ember/object';
import ScrollTracker from 'ember-api-docs/mixins/scroll-tracker';
import { pluralize } from 'ember-inflector';
import getFullVersion from 'ember-api-docs/utils/get-full-version';
import createExcerpt from 'ember-api-docs/utils/create-excerpt';
import { withScrollReset } from '../../../utils/with-scroll-reset';

export default class ClassRoute extends Route.extend(ScrollTracker) {
@withScrollReset
export default class ClassRoute extends Route {
/** @type {import('@ember/routing/router-service').default} */
@service
router;
Expand Down
5 changes: 3 additions & 2 deletions app/routes/project-version/modules/module.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import ClassRoute from '../classes/class';
import ScrollTracker from 'ember-api-docs/mixins/scroll-tracker';
import getFullVersion from 'ember-api-docs/utils/get-full-version';
import { withScrollReset } from '../../../utils/with-scroll-reset';

export default class ModuleRoute extends ClassRoute.extend(ScrollTracker) {
@withScrollReset
export default class ModuleRoute extends ClassRoute {
async model(params) {
const { project, project_version: compactVersion } =
this.paramsFor('project-version');
Expand Down
5 changes: 3 additions & 2 deletions app/routes/project-version/namespaces/namespace.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import ClassRoute from '../classes/class';
import ScrollTracker from 'ember-api-docs/mixins/scroll-tracker';
import getFullVersion from 'ember-api-docs/utils/get-full-version';
import { withScrollReset } from '../utils/with-scroll-reset';

export default class NamespaceRoute extends ClassRoute.extend(ScrollTracker) {
@withScrollReset
export default class NamespaceRoute extends ClassRoute {
templateName = 'project-version/classes/class';

async model(params) {
Expand Down
5 changes: 3 additions & 2 deletions app/routes/project.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import Route from '@ember/routing/route';
import ScrollTracker from 'ember-api-docs/mixins/scroll-tracker';
import { inject as service } from '@ember/service';
import { withScrollReset } from '../utils/with-scroll-reset';

export default class ProjectRoute extends Route.extend(ScrollTracker) {
@withScrollReset
export default class ProjectRoute extends Route {
/** @type {import('@ember/routing/router-service').default} */
@service
router;
Expand Down
12 changes: 12 additions & 0 deletions app/services/scroll-position-reset.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ export default class ScrollPositionResetService extends Service {
//TODO: Use routeInfo for reliable behavior
const dynamicSlugLocation = 3;

// These will be unset when first entering the app, in which case we know we
// are not changing tabs.
if (!transition.from || !transition.to) {
return false;
}

let fromRoutePathParts = transition.from.name.split('.');
let toRoutePathParts = transition.to.name.split('.');

Expand All @@ -57,6 +63,12 @@ export default class ScrollPositionResetService extends Service {
}

doReset() {
// No-op if we get called in FastBoot, since doing the `document` operations
// is by definition unsafe in that mode!
if (typeof FastBoot !== 'undefined') {
return;
}

if (this._shouldResetScroll) {
const selector = document.querySelector(scrollContainerSelector);
if (selector.scrollTo) {
Expand Down
58 changes: 58 additions & 0 deletions app/utils/with-scroll-reset.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import { inject as service } from '@ember/service';
import config from 'ember-api-docs/config/environment';
import getOffset from 'ember-api-docs/utils/get-offset';

/**
* Add scroll reset behavior to a `Route`.
*
* @param {import('@ember/routing/route').default} SomeRoute A Route class to
* decorate with the scroll position handling.
* @returns the decorated class
*/
export function withScrollReset(SomeRoute) {
class WithScrollReset extends SomeRoute {
/** @type {import('@ember/routing/router-service').default} */
@service
router;

/** @type {import('../services/scroll-position-reset').default} */
@service
scrollPositionReset;

constructor() {
super(...arguments);
this.router.on('routeWillChange', (transition) =>
this.scrollPositionReset.scheduleReset(transition)
);

this.router.on('routeDidChange', () => {
if (
typeof FastBoot === 'undefined' &&
window.location.search === '?anchor='
) {
let elem = document.querySelector('#methods');

if (elem && elem.offsetHeight) {
const offsetToScroll = getOffset(
elem,
config.APP.scrollContainerSelector
);
const scrollContainer = document.querySelector(
config.APP.scrollContainerSelector
);
if (scrollContainer.scrollTo) {
scrollContainer.scrollTo(0, offsetToScroll - 10);
} else {
// fallback for IE11
scrollContainer.scrollTop = offsetToScroll - 10;
}
return;
}
}
this.scrollPositionReset.doReset();
});
}
}

return WithScrollReset;
}
12 changes: 0 additions & 12 deletions tests/unit/mixins/scroll-tracker-test.js

This file was deleted.