mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-22 18:31:57 +03:00
52b924638d
- The frontend proxy is meant to be a way to pass critical internal pieces of Ghost core into the frontend - These fundamental @tryghost packages are shared and can be required directly, hence there's no need to pass them via the proxy - Reducing the surface area of the proxy reduces the proxies API - This makes it easier to see what's left in terms of decoupling the frontend, and what will always need to be passed (e.g. api) Note on @tryghost/social-urls: - this is a small utility that helps create URLs for social profiles, it's a util for working with data on the frontend aka part of the sdk - I think there should be many of these small helpers and we'll probably want to bundle them for the frontend at some point - for now, I'm leaving these as part of the proxy, as need to figure out where they belong
59 lines
2.3 KiB
JavaScript
59 lines
2.3 KiB
JavaScript
// ### Pagination Helper
|
|
// `{{pagination}}`
|
|
// Outputs previous and next buttons, along with info about the current page
|
|
const {templates, hbs} = require('../services/proxy');
|
|
|
|
const errors = require('@tryghost/errors');
|
|
const tpl = require('@tryghost/tpl');
|
|
const _ = require('lodash');
|
|
|
|
const messages = {
|
|
invalidData: 'The {{pagination}} helper was used outside of a paginated context. See https://ghost.org/docs/themes/helpers/pagination/.',
|
|
valuesMustBeDefined: 'All values must be defined for page, pages, limit and total',
|
|
nextPrevValuesMustBeNumeric: 'Invalid value, Next/Prev must be a number',
|
|
valuesMustBeNumeric: 'Invalid value, check page, pages, limit and total are numbers'
|
|
};
|
|
|
|
const createFrame = hbs.handlebars.createFrame;
|
|
|
|
module.exports = function pagination(options) {
|
|
options = options || {};
|
|
options.hash = options.hash || {};
|
|
options.data = options.data || {};
|
|
|
|
if (!_.isObject(this.pagination) || _.isFunction(this.pagination)) {
|
|
throw new errors.IncorrectUsageError({
|
|
level: 'normal',
|
|
message: tpl(messages.invalidData),
|
|
help: 'https://ghost.org/docs/themes/helpers/pagination/'
|
|
});
|
|
}
|
|
|
|
if (_.isUndefined(this.pagination.page) || _.isUndefined(this.pagination.pages) ||
|
|
_.isUndefined(this.pagination.total) || _.isUndefined(this.pagination.limit)) {
|
|
throw new errors.IncorrectUsageError({
|
|
message: tpl(messages.valuesMustBeDefined)
|
|
});
|
|
}
|
|
|
|
if ((!_.isNull(this.pagination.next) && !_.isNumber(this.pagination.next)) ||
|
|
(!_.isNull(this.pagination.prev) && !_.isNumber(this.pagination.prev))) {
|
|
throw new errors.IncorrectUsageError({
|
|
message: tpl(messages.nextPrevValuesMustBeNumeric)
|
|
});
|
|
}
|
|
|
|
if (!_.isNumber(this.pagination.page) || !_.isNumber(this.pagination.pages) ||
|
|
!_.isNumber(this.pagination.total) || !_.isNumber(this.pagination.limit)) {
|
|
throw new errors.IncorrectUsageError({message: tpl(messages.valuesMustBeNumeric)});
|
|
}
|
|
|
|
// CASE: The pagination helper should have access to the pagination properties at the top level.
|
|
_.merge(this, this.pagination);
|
|
// CASE: The pagination helper will forward attributes passed to it.
|
|
_.merge(this, options.hash);
|
|
const data = createFrame(options.data);
|
|
|
|
return templates.execute('pagination', this, {data});
|
|
};
|