umberto 6.0.0 → 6.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +3 -0
- package/package.json +1 -1
- package/scripts/filter/before-post-render/set-layout.js +9 -11
- package/src/api-builder/classes/doc-data-factory.js +1 -1
- package/src/data-converter/converters/typedoc/typedocconverter.js +6 -3
- package/src/index.js +108 -146
- package/src/tasks/build-api-docs.js +4 -4
- package/src/tasks/build-documentation.js +9 -3
- package/src/tasks/build-sdk.js +25 -9
- package/src/tasks/copy-assets.js +9 -9
- package/src/tasks/create-sym-links.js +2 -3
- package/themes/umberto/layout/{404.pug → gloria/404.pug} +1 -1
- package/themes/umberto/layout/gloria/_api-docs/_mixin/_type.pug +187 -0
- package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/class.pug +1 -1
- package/themes/umberto/layout/gloria/_api-docs/interface.pug +10 -0
- package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/mixin.pug +1 -1
- package/themes/umberto/layout/gloria/_api-docs/module.pug +10 -0
- package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/namespace.pug +1 -1
- package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/typedef.pug +1 -1
- package/themes/umberto/layout/{_partial → gloria/_partial}/gh-contribute.pug +2 -2
- package/themes/umberto/layout/{_partial → gloria/_partial}/head.pug +2 -2
- package/themes/umberto/layout/{_partial → gloria/_partial}/search-box.pug +1 -1
- package/themes/umberto/layout/{api.pug → gloria/api.pug} +1 -1
- package/themes/umberto/layout/{base.pug → gloria/base.pug} +1 -1
- package/themes/umberto/layout/{sdk.pug → gloria/sdk.pug} +1 -1
- package/themes/umberto/layout/umberto/404.pug +22 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_api-see-source.pug +11 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_api-title.pug +17 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_api-tree-item.pug +30 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_badge.pug +17 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_class-item.pug +29 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_dev-names.pug +9 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_error.pug +23 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_fires-item.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_hierarchy-item.pug +14 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_hierarchy-list.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_link-or-text.pug +43 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_method.pug +89 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_params.pug +44 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_property.pug +51 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_related.pug +8 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_return.pug +14 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_sidebox-list-item.pug +8 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/_sidebox-list.pug +8 -0
- package/themes/umberto/layout/umberto/_api-docs/_mixin/type-parameter.pug +18 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/api-info-box.pug +30 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/api-subheader.pug +22 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/classes.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/config-options.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/constants.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/description.pug +9 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/events.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/filter.pug +40 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/functions.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/interfaces.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/loading-spinner.pug +2 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/methods.pug +19 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/namespaces.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/navtree.pug +13 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/properties.pug +19 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/type-parameters.pug +26 -0
- package/themes/umberto/layout/umberto/_api-docs/_partial/typedefs.pug +7 -0
- package/themes/umberto/layout/umberto/_api-docs/api-base.pug +45 -0
- package/themes/umberto/layout/{_api-docs/interface.pug → umberto/_api-docs/class.pug} +1 -1
- package/themes/umberto/layout/umberto/_api-docs/errors.pug +6 -0
- package/themes/umberto/layout/umberto/_api-docs/interface.pug +10 -0
- package/themes/umberto/layout/{_api-docs/module.pug → umberto/_api-docs/mixin.pug} +1 -1
- package/themes/umberto/layout/umberto/_api-docs/module.pug +10 -0
- package/themes/umberto/layout/umberto/_api-docs/namespace.pug +10 -0
- package/themes/umberto/layout/umberto/_api-docs/typedef.pug +37 -0
- package/themes/umberto/layout/umberto/_mixin/nav-tree-item.pug +13 -0
- package/themes/umberto/layout/umberto/_mixin/nav-tree-level.pug +38 -0
- package/themes/umberto/layout/umberto/_partial/docsearch.pug +21 -0
- package/themes/umberto/layout/umberto/_partial/dropdown.pug +12 -0
- package/themes/umberto/layout/umberto/_partial/feedback-widget.pug +20 -0
- package/themes/umberto/layout/umberto/_partial/footer.pug +6 -0
- package/themes/umberto/layout/umberto/_partial/gh-contribute.pug +8 -0
- package/themes/umberto/layout/umberto/_partial/google-analytics.pug +19 -0
- package/themes/umberto/layout/umberto/_partial/google-tag-manager.pug +18 -0
- package/themes/umberto/layout/umberto/_partial/head.pug +67 -0
- package/themes/umberto/layout/umberto/_partial/header.pug +64 -0
- package/themes/umberto/layout/umberto/_partial/nav-tree.pug +9 -0
- package/themes/umberto/layout/umberto/_partial/report-issue-widget.pug +26 -0
- package/themes/umberto/layout/umberto/_partial/rwd-breadcrumbs.pug +13 -0
- package/themes/umberto/layout/umberto/_partial/search-box.pug +6 -0
- package/themes/umberto/layout/umberto/_partial/vwo.pug +11 -0
- package/themes/umberto/layout/umberto/_sdk/_mixin/_sdk-sample-item.pug +5 -0
- package/themes/umberto/layout/umberto/_sdk/_mixin/_sdk-samples.pug +7 -0
- package/themes/umberto/layout/umberto/_sdk/_mixin/_sdk-tree-item.pug +7 -0
- package/themes/umberto/layout/umberto/_sdk/_mixin/_sdk-tree-level.pug +29 -0
- package/themes/umberto/layout/umberto/_sdk/_partial/navtree.pug +4 -0
- package/themes/umberto/layout/umberto/_sdk/page.pug +23 -0
- package/themes/umberto/layout/umberto/api.pug +27 -0
- package/themes/umberto/layout/umberto/base.pug +42 -0
- package/themes/umberto/layout/umberto/index.pug +17 -0
- package/themes/umberto/layout/umberto/page.pug +28 -0
- package/themes/umberto/layout/umberto/sdk.pug +29 -0
- package/themes/umberto/source/umberto/assets/_img/info-circle.svg +4 -0
- package/themes/umberto/source/umberto/assets/_img/triangle-right.svg +1 -0
- package/themes/umberto/src/umberto/css/_api-content.scss +32 -0
- package/themes/umberto/src/umberto/css/_api-info-box.scss +86 -0
- package/themes/umberto/src/umberto/css/_api-props-filter.scss +106 -0
- package/themes/umberto/src/umberto/css/_api-see-source.scss +35 -0
- package/themes/umberto/src/umberto/css/_api-subheader.scss +167 -0
- package/themes/umberto/src/umberto/css/_api-tree.scss +121 -0
- package/themes/umberto/src/umberto/css/_badge.scss +74 -0
- package/themes/umberto/src/umberto/css/_code-switcher.scss +61 -0
- package/themes/umberto/src/umberto/css/_collapsinglist.scss +262 -0
- package/themes/umberto/src/umberto/css/_content.scss +236 -0
- package/themes/umberto/src/umberto/css/_docsearch.scss +109 -0
- package/themes/umberto/src/umberto/css/_dropdown.scss +63 -0
- package/themes/umberto/src/umberto/css/_editor-icon.scss +26 -0
- package/themes/umberto/src/umberto/css/_feedback-widget.scss +11 -0
- package/themes/umberto/src/umberto/css/_font-external.scss +8 -0
- package/themes/umberto/src/umberto/css/_footer.scss +40 -0
- package/themes/umberto/src/umberto/css/_formatted.scss +285 -0
- package/themes/umberto/src/umberto/css/_guide-content.scss +37 -0
- package/themes/umberto/src/umberto/css/_guide-sdk-tree.scss +14 -0
- package/themes/umberto/src/umberto/css/_loading-spinner.scss +33 -0
- package/themes/umberto/src/umberto/css/_main.scss +59 -0
- package/themes/umberto/src/umberto/css/_navigation.scss +35 -0
- package/themes/umberto/src/umberto/css/_notice.scss +116 -0
- package/themes/umberto/src/umberto/css/_print.scss +20 -0
- package/themes/umberto/src/umberto/css/_prism.scss +223 -0
- package/themes/umberto/src/umberto/css/_rwd-breadcrumbs.scss +28 -0
- package/themes/umberto/src/umberto/css/_rwd-menu.scss +89 -0
- package/themes/umberto/src/umberto/css/_secondary-navigation.scss +152 -0
- package/themes/umberto/src/umberto/css/_theme-dark.scss +175 -0
- package/themes/umberto/src/umberto/css/_toggler.scss +46 -0
- package/themes/umberto/src/umberto/css/_top.scss +350 -0
- package/themes/umberto/src/umberto/css/_tree.scss +218 -0
- package/themes/umberto/src/umberto/css/_warning-banner.scss +46 -0
- package/themes/umberto/src/umberto/css/components/_lightbox.scss +12 -0
- package/themes/umberto/src/umberto/css/helpers/_color.scss +49 -0
- package/themes/umberto/src/umberto/css/helpers/_font.scss +60 -0
- package/themes/umberto/src/umberto/css/helpers/_globals.scss +129 -0
- package/themes/umberto/src/umberto/css/helpers/_reset.scss +52 -0
- package/themes/umberto/src/umberto/css/helpers/_spacing.scss +21 -0
- package/themes/umberto/src/umberto/css/pages/_sdk.scss +111 -0
- package/themes/umberto/src/umberto/css/styles.scss +117 -0
- package/themes/umberto/src/umberto/js/_anchors.js +57 -0
- package/themes/umberto/src/umberto/js/_apisearch.js +126 -0
- package/themes/umberto/src/umberto/js/_apitree.js +67 -0
- package/themes/umberto/src/umberto/js/_attachpermalinklistener.js +50 -0
- package/themes/umberto/src/umberto/js/_codeswitcherbuttons.js +146 -0
- package/themes/umberto/src/umberto/js/_collapsables.js +135 -0
- package/themes/umberto/src/umberto/js/_copymobileapinavigation.js +26 -0
- package/themes/umberto/src/umberto/js/_devnames.js +37 -0
- package/themes/umberto/src/umberto/js/_dropdowns.js +55 -0
- package/themes/umberto/src/umberto/js/_filtering.js +139 -0
- package/themes/umberto/src/umberto/js/_imageModal.js +16 -0
- package/themes/umberto/src/umberto/js/_pagenavigation.js +93 -0
- package/themes/umberto/src/umberto/js/_prism.js +104 -0
- package/themes/umberto/src/umberto/js/_rwdmenu.js +15 -0
- package/themes/umberto/src/umberto/js/_samplecode.js +23 -0
- package/themes/umberto/src/umberto/js/_sidenavigation.js +59 -0
- package/themes/umberto/src/umberto/js/_toc.js +93 -0
- package/themes/umberto/src/umberto/js/_tooltips.js +39 -0
- package/themes/umberto/src/umberto/js/_warningbanner.js +18 -0
- package/themes/umberto/src/umberto/js/app.js +70 -0
- package/themes/umberto/src/umberto/js/vendor/prism.js +45 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_api-see-source.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_api-title.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_api-tree-item.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_badge.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_class-item.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_dev-names.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_error.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_fires-item.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_hierarchy-item.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_hierarchy-list.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_link-or-text.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_method.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_params.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_property.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_related.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_return.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_sidebox-list-item.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/_sidebox-list.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_mixin/type-parameter.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/api-info-box.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/api-subheader.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/classes.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/config-options.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/constants.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/description.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/events.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/filter.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/functions.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/interfaces.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/loading-spinner.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/methods.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/namespaces.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/navtree.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/properties.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/type-parameters.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/_partial/typedefs.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/api-base.pug +0 -0
- /package/themes/umberto/layout/{_api-docs → gloria/_api-docs}/errors.pug +0 -0
- /package/themes/umberto/layout/{_mixin → gloria/_mixin}/nav-tree-item.pug +0 -0
- /package/themes/umberto/layout/{_mixin → gloria/_mixin}/nav-tree-level.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/docsearch.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/dropdown.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/feedback-widget.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/footer.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/google-analytics.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/google-tag-manager.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/header.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/nav-tree.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/report-issue-widget.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/rwd-breadcrumbs.pug +0 -0
- /package/themes/umberto/layout/{_partial → gloria/_partial}/vwo.pug +0 -0
- /package/themes/umberto/layout/{_sdk → gloria/_sdk}/_mixin/_sdk-sample-item.pug +0 -0
- /package/themes/umberto/layout/{_sdk → gloria/_sdk}/_mixin/_sdk-samples.pug +0 -0
- /package/themes/umberto/layout/{_sdk → gloria/_sdk}/_mixin/_sdk-tree-item.pug +0 -0
- /package/themes/umberto/layout/{_sdk → gloria/_sdk}/_mixin/_sdk-tree-level.pug +0 -0
- /package/themes/umberto/layout/{_sdk → gloria/_sdk}/_partial/navtree.pug +0 -0
- /package/themes/umberto/layout/{_sdk → gloria/_sdk}/page.pug +0 -0
- /package/themes/umberto/layout/{index.pug → gloria/index.pug} +0 -0
- /package/themes/umberto/layout/{page.pug → gloria/page.pug} +0 -0
- /package/themes/umberto/layout/{_api-docs → umberto/_api-docs}/_mixin/_type.pug +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/arrows.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/book.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/box-brown.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/box-orange.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/box-red.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/bulb.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/clipboard.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/cog.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/data.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/documentation.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/download.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/edit.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/exclamation-circle.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/eye.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/filter.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/filtering.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/folder.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/github.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/header-info-configs.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/header-info-events.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/header-info-methods.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/header-info-properties.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/heart.svg +0 -0
- /package/themes/umberto/source/{assets → gloria/assets}/_img/info-circle.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/info.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/list-nest.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/loupe.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/menu.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/plug.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/star-in-circle.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/tick.svg +0 -0
- /package/themes/{nova/source → umberto/source/gloria}/assets/_img/triangle-down.svg +0 -0
- /package/themes/umberto/source/{assets → gloria/assets}/_img/triangle-right.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/arrows.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/book.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/box-brown.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/box-orange.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/box-red.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/bulb.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/clipboard.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/cog.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/data.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/documentation.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/download.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/edit.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/exclamation-circle.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/eye.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/filter.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/filtering.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/folder.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/github.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/header-info-configs.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/header-info-events.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/header-info-methods.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/header-info-properties.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/heart.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/info.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/list-nest.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/loupe.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/menu.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/plug.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/star-in-circle.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/tick.svg +0 -0
- /package/themes/umberto/source/{assets → umberto/assets}/_img/triangle-down.svg +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_api-content.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_api-info-box.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_api-props-filter.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_api-see-source.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_api-subheader.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_api-tree.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_badge.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_code-switcher.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_collapsinglist.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_content.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_docsearch.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_dropdown.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_editor-icon.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_feedback-widget.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_font-external.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_footer.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_formatted.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_guide-content.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_guide-sdk-tree.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_loading-spinner.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_main.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_navigation.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_notice.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_print.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_prism.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_rwd-breadcrumbs.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_rwd-menu.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_secondary-navigation.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_theme-dark.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_toggler.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_top.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_tree.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/_warning-banner.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/components/_lightbox.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/helpers/_color.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/helpers/_font.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/helpers/_globals.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/helpers/_reset.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/helpers/_spacing.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/pages/_sdk.scss +0 -0
- /package/themes/umberto/src/{css → gloria/css}/styles.scss +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_anchors.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_apisearch.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_apitree.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_attachpermalinklistener.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_codeswitcherbuttons.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_collapsables.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_copymobileapinavigation.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_devnames.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_dropdowns.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_filtering.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_imageModal.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_pagenavigation.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_prism.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_rwdmenu.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_samplecode.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_sidenavigation.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_toc.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_tooltips.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/_warningbanner.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/app.js +0 -0
- /package/themes/umberto/src/{js → gloria/js}/vendor/prism.js +0 -0
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
include ./_link-or-text.pug
|
|
2
|
+
|
|
3
|
+
mixin type( types, isOptional = false )
|
|
4
|
+
each nameOrObject, index in types
|
|
5
|
+
+renderType( nameOrObject )
|
|
6
|
+
|
|
7
|
+
if index < types.length - 1
|
|
8
|
+
| !{ ' | ' }
|
|
9
|
+
|
|
10
|
+
if ( isOptional && !types.includes( 'undefined' ) )
|
|
11
|
+
| !{ ' | ' }
|
|
12
|
+
+renderType( 'undefined' )
|
|
13
|
+
|
|
14
|
+
//- TODO: Description.
|
|
15
|
+
//-
|
|
16
|
+
//- @param {String|*} inlineObjectOrType
|
|
17
|
+
mixin renderStringValue( inlineObjectOrType )
|
|
18
|
+
//- An inline object specified as string.
|
|
19
|
+
if ( typeof inlineObjectOrType === 'string' && inlineObjectOrType.startsWith( '{' ) )
|
|
20
|
+
| !{ inlineObjectOrType }
|
|
21
|
+
else
|
|
22
|
+
+linkOrText( inlineObjectOrType, {
|
|
23
|
+
aClass: 'collapsing-list__type'
|
|
24
|
+
} )
|
|
25
|
+
|
|
26
|
+
//- TODO: Description.
|
|
27
|
+
//-
|
|
28
|
+
//- @param {Object} complexType
|
|
29
|
+
//- @param {'function'|'predicate'|'operator'|'generic'} complexType.type
|
|
30
|
+
//- @param {Array.<*>} [complexType.params]
|
|
31
|
+
//- @param {String} [complexType.name]
|
|
32
|
+
//- @param {Array.<*>} [complexType.instances]
|
|
33
|
+
//- @param {String} [complexType.operator]
|
|
34
|
+
//- @param {Array.<*>} [complexType.values]
|
|
35
|
+
//- @param {String} [complexType.name]
|
|
36
|
+
//- @param {Array.<*>} [complexType.typeParameters]
|
|
37
|
+
mixin renderComplexStructure( complexType )
|
|
38
|
+
//- Inline callback.
|
|
39
|
+
if ( complexType.type === 'function' && complexType.params && complexType.returns )
|
|
40
|
+
+renderInlineFunction( complexType )
|
|
41
|
+
|
|
42
|
+
//- Predicate.
|
|
43
|
+
//-
|
|
44
|
+
//- The goal is to display whether an object is an instance of an array of modules.
|
|
45
|
+
//- E.g.: `this is "Model"`
|
|
46
|
+
if ( complexType.type === 'predicate' && complexType.name && complexType.instances )
|
|
47
|
+
i= complexType.name
|
|
48
|
+
| !{ ' is ' }
|
|
49
|
+
+renderUnion( complexType.instances )
|
|
50
|
+
|
|
51
|
+
//- Type operator.
|
|
52
|
+
//-
|
|
53
|
+
//- The goal is to display the type operator keyword before rendering a type.
|
|
54
|
+
if ( complexType.type === 'operator' && complexType.operator && complexType.values )
|
|
55
|
+
i= complexType.operator
|
|
56
|
+
| !{ ' ' }
|
|
57
|
+
+renderType( complexType.values )
|
|
58
|
+
|
|
59
|
+
//- An object with type arguments.
|
|
60
|
+
if ( complexType.type === 'generic' && complexType.name && ( complexType.typeParameters || complexType.typeParameter ) )
|
|
61
|
+
+renderGenericType( complexType )
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
//- Renders a structure for an union, an array or a single type specified as a string.
|
|
65
|
+
//-
|
|
66
|
+
//- * Union: Foo | Bar | Baz
|
|
67
|
+
//- * Array: Array<Foo | Bar | Baz>
|
|
68
|
+
//- * String: Foo
|
|
69
|
+
//-
|
|
70
|
+
//- All types are linkable if they point to an existing JSDoc doclet.
|
|
71
|
+
//-
|
|
72
|
+
//- @param {Set|Array|String} type
|
|
73
|
+
mixin renderType( type )
|
|
74
|
+
//- Because of `typeof null === 'object'`...
|
|
75
|
+
if ( type )
|
|
76
|
+
//- Backward compatibility, when passing a `module:...` string.
|
|
77
|
+
if ( typeof type === 'string' )
|
|
78
|
+
+renderStringValue( type )
|
|
79
|
+
//- `intrinsic` type.
|
|
80
|
+
else if ( type.elementType )
|
|
81
|
+
| #{ type.elementType.name }
|
|
82
|
+
else
|
|
83
|
+
//- Complex structures introduced when generating API pages from TypeScript.
|
|
84
|
+
if ( type instanceof Set )
|
|
85
|
+
+renderUnion( [ ...type ] )
|
|
86
|
+
else if ( Array.isArray( type ) )
|
|
87
|
+
| !{ 'Array<' }
|
|
88
|
+
+renderUnion( type )
|
|
89
|
+
| !{ '>' }
|
|
90
|
+
else if ( typeof type === 'object' )
|
|
91
|
+
+renderComplexStructure( type )
|
|
92
|
+
|
|
93
|
+
//- Renders an union structure, e.g., `Foo | Bar | Baz`.
|
|
94
|
+
//-
|
|
95
|
+
//- All types are linkable if they point to an existing JSDoc doclet.
|
|
96
|
+
//-
|
|
97
|
+
//- @param {Array.<String>} type
|
|
98
|
+
mixin renderUnion( iterable )
|
|
99
|
+
each item, index in iterable
|
|
100
|
+
+renderType( item )
|
|
101
|
+
if index < iterable.length - 1
|
|
102
|
+
| !{ ' | ' }
|
|
103
|
+
|
|
104
|
+
//- Draws an inline callback structure.
|
|
105
|
+
//-
|
|
106
|
+
//- E.g.: `( ArgumentFoo | ArgumentBar, AnotherArgument ) => ReturnType`
|
|
107
|
+
//- If specified names are modules, they should point to the proper API page.
|
|
108
|
+
//-
|
|
109
|
+
//- @param {Object} callback
|
|
110
|
+
//- @param {String} callback.type
|
|
111
|
+
//- @param {Array} callback.params
|
|
112
|
+
//- @param {Object} callback.returns
|
|
113
|
+
//- @param {Boolean} callback.isClass
|
|
114
|
+
mixin renderInlineFunction( callback )
|
|
115
|
+
if ( callback.isClass )
|
|
116
|
+
i !{ 'new' }
|
|
117
|
+
| !{ ' ' }
|
|
118
|
+
|
|
119
|
+
//- (1) Start with an opening parenthesis.
|
|
120
|
+
//- It prints `( ` or `(` depending on required arguments by a callback.
|
|
121
|
+
if ( callback.params.length )
|
|
122
|
+
| (!{ ' ' }
|
|
123
|
+
else
|
|
124
|
+
| (
|
|
125
|
+
|
|
126
|
+
//- (2) Arguments parsing. They are seperated by coma (`, `).
|
|
127
|
+
each paramObject, paramIndex in callback.params
|
|
128
|
+
if ( 'name' in paramObject && 'type' in paramObject )
|
|
129
|
+
//- (3.a) Process a single argument when it is an object.
|
|
130
|
+
| #{ paramObject.name }:
|
|
131
|
+
+renderType( paramObject.type )
|
|
132
|
+
if paramIndex < callback.params.length - 1
|
|
133
|
+
| !{ ', ' }
|
|
134
|
+
else
|
|
135
|
+
//- (3.b) Process a single argument.
|
|
136
|
+
+renderType( paramObject )
|
|
137
|
+
if paramIndex < callback.params.length - 1
|
|
138
|
+
| !{ ', ' }
|
|
139
|
+
|
|
140
|
+
//- (4) Close the parenthesis. Define the returned type.
|
|
141
|
+
//- It prints ` ) => ` or `) => ` depending on required arguments by the callback.
|
|
142
|
+
if ( callback.params.length )
|
|
143
|
+
| !{ ' ' }) => !{ ' ' }
|
|
144
|
+
else
|
|
145
|
+
| ) => !{ ' ' }
|
|
146
|
+
|
|
147
|
+
//- Wraps the returned type in brackets to avoid confusions if a type is returned by the callback,
|
|
148
|
+
//- or it is a new type (outside the callback). See #1063.
|
|
149
|
+
if ( callback.returns instanceof Set )
|
|
150
|
+
| (!{ ' ' }
|
|
151
|
+
|
|
152
|
+
//- (5) Process the returned type that can be an union, an array of a type.
|
|
153
|
+
+renderType( callback.returns )
|
|
154
|
+
|
|
155
|
+
//- See #1063.
|
|
156
|
+
if ( callback.returns instanceof Set )
|
|
157
|
+
| !{ ' ' })
|
|
158
|
+
|
|
159
|
+
//- TODO: Description
|
|
160
|
+
//-
|
|
161
|
+
//- @param {Object} generic
|
|
162
|
+
//- @param {'generic'} generic.type
|
|
163
|
+
//- @param {String} generic.name
|
|
164
|
+
//- @param {Set.<String>} generic.names
|
|
165
|
+
//- @param {Array.<*>} [generic.typeParameters]
|
|
166
|
+
//- @param {*} [generic.typeParameter]
|
|
167
|
+
mixin renderGenericType( generic )
|
|
168
|
+
+renderType( generic.name )
|
|
169
|
+
|
|
170
|
+
if ( generic.typeParameters )
|
|
171
|
+
| !{ '<' }
|
|
172
|
+
each type, typeIndex in generic.typeParameters
|
|
173
|
+
if ( typeof type === 'string' )
|
|
174
|
+
+renderStringValue( type )
|
|
175
|
+
else
|
|
176
|
+
//- Nested generics.
|
|
177
|
+
+renderGenericType( type )
|
|
178
|
+
|
|
179
|
+
if typeIndex < generic.typeParameters.length - 1
|
|
180
|
+
| !{ ', ' }
|
|
181
|
+
| !{ '>' }
|
|
182
|
+
|
|
183
|
+
if ( generic.typeParameter )
|
|
184
|
+
| !{ '[ ' }
|
|
185
|
+
+renderType( generic.typeParameter )
|
|
186
|
+
| !{ ' ]' }
|
|
187
|
+
|
|
@@ -2,7 +2,7 @@ extends api-base
|
|
|
2
2
|
include ./_mixin/_api-title
|
|
3
3
|
|
|
4
4
|
block prepend content
|
|
5
|
-
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/cog.svg', kind: 'Class' } )
|
|
5
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/gloria/img/cog.svg', kind: 'Class' } )
|
|
6
6
|
|
|
7
7
|
//- Make sure to add the report issue widget at the end of the page.
|
|
8
8
|
block append content
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
extends api-base
|
|
2
|
+
include ./_mixin/_api-title
|
|
3
|
+
|
|
4
|
+
block prepend content
|
|
5
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/gloria/img/arrows.svg', kind: 'Interface' } )
|
|
6
|
+
|
|
7
|
+
//- Make sure to add the report issue widget at the end of the page.
|
|
8
|
+
block append content
|
|
9
|
+
if page.reportIssueWidget
|
|
10
|
+
include ../_partial/report-issue-widget
|
|
@@ -2,7 +2,7 @@ extends api-base
|
|
|
2
2
|
include ./_mixin/_api-title
|
|
3
3
|
|
|
4
4
|
block prepend content
|
|
5
|
-
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/cog.svg', kind: 'Mixin' } )
|
|
5
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/gloria/img/cog.svg', kind: 'Mixin' } )
|
|
6
6
|
|
|
7
7
|
//- Make sure to add the report issue widget at the end of the page.
|
|
8
8
|
block append content
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
extends api-base
|
|
2
|
+
include ./_mixin/_api-title
|
|
3
|
+
|
|
4
|
+
block prepend content
|
|
5
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/gloria/img/box-red.svg', kind: 'Module' } )
|
|
6
|
+
|
|
7
|
+
//- Make sure to add the report issue widget at the end of the page.
|
|
8
|
+
block append content
|
|
9
|
+
if page.reportIssueWidget
|
|
10
|
+
include ../_partial/report-issue-widget
|
|
@@ -2,7 +2,7 @@ extends api-base
|
|
|
2
2
|
include ./_mixin/_api-title
|
|
3
3
|
|
|
4
4
|
block prepend content
|
|
5
|
-
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/box-brown.svg', kind: 'Namespace' } )
|
|
5
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/gloria/img/box-brown.svg', kind: 'Namespace' } )
|
|
6
6
|
|
|
7
7
|
//- Make sure to add the report issue widget at the end of the page.
|
|
8
8
|
block append content
|
|
@@ -6,7 +6,7 @@ include ./_mixin/_related
|
|
|
6
6
|
include ./_mixin/_link-or-text
|
|
7
7
|
|
|
8
8
|
block prepend content
|
|
9
|
-
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/img/data.svg', kind: 'Typedef' } )
|
|
9
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/gloria/img/data.svg', kind: 'Typedef' } )
|
|
10
10
|
|
|
11
11
|
block append content
|
|
12
12
|
if data.types.length == 1 && data.types[ 0 ] == 'function'
|
|
@@ -2,7 +2,7 @@ if page.issuesUrl || page.contributeUrl
|
|
|
2
2
|
div.github-contrib
|
|
3
3
|
if page.contributeUrl
|
|
4
4
|
a( href=page.contributeUrl title="Contribute to this guide" )
|
|
5
|
-
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/img/edit.svg' ) alt="Contribute to this guide" )
|
|
5
|
+
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/gloria/img/edit.svg' ) alt="Contribute to this guide" )
|
|
6
6
|
if page.issuesUrl
|
|
7
7
|
a( href=page.issuesUrl title="Report an issue" )
|
|
8
|
-
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/img/exclamation-circle.svg' ) alt="Report an issue" )
|
|
8
|
+
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/gloria/img/exclamation-circle.svg' ) alt="Report an issue" )
|
|
@@ -25,7 +25,7 @@ if ( mainOg || ( projectLocals && projectLocals.og ) || page[ 'og-description' ]
|
|
|
25
25
|
- const hostname = mainOg.hostname || ogConfig.hostname;
|
|
26
26
|
meta( property='og:image' content= hostname + pathJoin( '/docs', page.latestBasePath || '/', ogConfig.image ? ogConfig.image : mainOg.image) )
|
|
27
27
|
meta( property='og:type' content='website' )
|
|
28
|
-
if ( page.layout === 'index' )
|
|
28
|
+
if ( page.layout === 'gloria/index' )
|
|
29
29
|
meta( property='og:url' content= page.canonicalUrlBeginning + 'index.html' )
|
|
30
30
|
else
|
|
31
31
|
meta( property='og:url' content= page.canonicalUrlBeginning + page.path.replace( page.BASE_PATH, projectLocals.latestBasePath ) )
|
|
@@ -51,7 +51,7 @@ if page.BASE_PATH
|
|
|
51
51
|
if ( docSearchConfig && docSearchConfig.isEnabled && !disableSearch && (!projectLocals || !projectLocals.disableSearch) )
|
|
52
52
|
link( rel = 'stylesheet', href = docSearchConfig.css )
|
|
53
53
|
|
|
54
|
-
link( rel = 'stylesheet', href = relative_url( page.path, 'assets/' + umbertoVersion + '/css/styles.css' ), type='text/css' media='all' )
|
|
54
|
+
link( rel = 'stylesheet', href = relative_url( page.path, 'assets/' + umbertoVersion + '/gloria/css/styles.css' ), type='text/css' media='all' )
|
|
55
55
|
|
|
56
56
|
if projectLocals
|
|
57
57
|
each path in projectLocals.extraStylePaths
|
|
@@ -3,4 +3,4 @@ if !disableSearch && (!projectLocals || !projectLocals.disableSearch)
|
|
|
3
3
|
div.top__search
|
|
4
4
|
input( type="text", id="docsearch_input", class="top__search__box", placeholder=placeholder )
|
|
5
5
|
div( class="top__search__button")
|
|
6
|
-
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/img/loupe.svg' ) alt="Search" )
|
|
6
|
+
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/gloria/img/loupe.svg' ) alt="Search" )
|
|
@@ -4,7 +4,7 @@ block content
|
|
|
4
4
|
- const split = uSplitToTitleAndContent( page.content );
|
|
5
5
|
|
|
6
6
|
h1.main__content-title( data-ln = page.shortName === 'index' ? page[ 'default-expanded' ] || page.shortName : page.shortName )
|
|
7
|
-
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/img/cog.svg' ) alt="API" )
|
|
7
|
+
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/gloria/img/cog.svg' ) alt="API" )
|
|
8
8
|
!= split.title || page.title
|
|
9
9
|
|
|
10
10
|
!= split.content
|
|
@@ -32,7 +32,7 @@ html( lang='en' )
|
|
|
32
32
|
include _partial/footer
|
|
33
33
|
include _partial/docsearch
|
|
34
34
|
|
|
35
|
-
script( src = relative_url( page.path, pathJoin( 'assets', umbertoVersion, 'scripts/app.js' ) ) )
|
|
35
|
+
script( src = relative_url( page.path, pathJoin( 'assets', umbertoVersion, 'gloria/scripts/app.js' ) ) )
|
|
36
36
|
|
|
37
37
|
if page.isSnippetPage
|
|
38
38
|
//UMBERTO: SNIPPET: JS
|
|
@@ -4,7 +4,7 @@ block content
|
|
|
4
4
|
- const split = uSplitToTitleAndContent( page.content );
|
|
5
5
|
|
|
6
6
|
h1.main__content-title
|
|
7
|
-
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/img/book.svg' ) alt="guide" )
|
|
7
|
+
img( src=relative_url( page.path, 'assets/' + umbertoVersion + '/gloria/img/book.svg' ) alt="guide" )
|
|
8
8
|
!= split.title || page.title
|
|
9
9
|
|
|
10
10
|
if page.toc !== false
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
doctype html
|
|
2
|
+
html( lang='en' )
|
|
3
|
+
head
|
|
4
|
+
meta( charset='utf-8' )
|
|
5
|
+
meta( name="viewport" content="width=device-width, initial-scale=1")
|
|
6
|
+
title= page[ 'meta-title' ] ? page[ 'meta-title' ] : page.title
|
|
7
|
+
link( rel = 'stylesheet', href = '/assets/' + umbertoVersion + '/umberto/css/styles.css', type='text/css' media='screen' )
|
|
8
|
+
body
|
|
9
|
+
header.top
|
|
10
|
+
|
|
11
|
+
main( class = 'main main--no-sitenav' )
|
|
12
|
+
section( class = 'main__content formatted' )
|
|
13
|
+
|
|
14
|
+
.main__content-inner
|
|
15
|
+
- const split = uSplitToTitleAndContent( page.content );
|
|
16
|
+
|
|
17
|
+
h1
|
|
18
|
+
!= split.title || page.title
|
|
19
|
+
|
|
20
|
+
!= split.content
|
|
21
|
+
|
|
22
|
+
include _partial/footer
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
mixin seeSource( item )
|
|
2
|
+
//- Do not render "See source" button if the module or the parsed item (e.g. a function) has the `@skipsource` annotation
|
|
3
|
+
if ( projectLocals.seeSourceRepositoryUrl && item.file && !( data.skipSource || item.skipSource ) )
|
|
4
|
+
- const link = item.file.url || projectLocals.getLinkToSource( projectLocals.seeSourceRepositoryUrl, item.file );
|
|
5
|
+
|
|
6
|
+
if link
|
|
7
|
+
.see-source
|
|
8
|
+
a( href=link target='_blank' rel="noopener noreferrer" )
|
|
9
|
+
svg( viewBox='0 0 1024 1024' )
|
|
10
|
+
path( d='M512 0C229.12 0 0 229.12 0 512c0 226.56 146.56 417.92 350.08 485.76 25.6 4.48 35.2-10.88 35.2-24.32 0-12.16-.64-52.48-.64-95.36-128.64 23.68-161.92-31.36-172.16-60.16-5.76-14.72-30.72-60.16-52.48-72.32-17.92-9.6-43.52-33.28-.64-33.92 40.32-.64 69.12 37.12 78.72 52.48 46.08 77.44 119.68 55.68 149.12 42.24 4.48-33.28 17.92-55.68 32.64-68.48-113.92-12.8-232.96-56.96-232.96-252.8 0-55.68 19.84-101.76 52.48-137.6-5.12-12.8-23.04-65.28 5.12-135.68 0 0 42.88-13.44 140.8 52.48 40.96-11.52 84.48-17.28 128-17.28 43.52 0 87.04 5.76 128 17.28 97.92-66.56 140.8-52.48 140.8-52.48 28.16 70.4 10.24 122.88 5.12 135.68 32.64 35.84 52.48 81.28 52.48 137.6 0 196.48-119.68 240-233.6 252.8 18.56 16 34.56 46.72 34.56 94.72 0 68.48-.64 123.52-.64 140.8 0 13.44 9.6 29.44 35.2 24.32C877.44 929.92 1024 737.92 1024 512 1024 229.12 794.88 0 512 0z' )
|
|
11
|
+
| See source
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
include _type
|
|
2
|
+
|
|
3
|
+
mixin apiTitle( config )
|
|
4
|
+
div.api-header
|
|
5
|
+
img( src=relative_url( page.path, config.iconPath ) alt=config.kind title=config.kind )
|
|
6
|
+
|
|
7
|
+
div.api-header__title
|
|
8
|
+
h1( data-ln = data.longname )
|
|
9
|
+
!= data.name
|
|
10
|
+
|
|
11
|
+
if ( config.kind !== 'Module' && page.shortHiddenPath )
|
|
12
|
+
span.header__import--hidden
|
|
13
|
+
!= ` (${ page.shortHiddenPath })`
|
|
14
|
+
|
|
15
|
+
if ( page.realImportPath )
|
|
16
|
+
p.header__import
|
|
17
|
+
!= page.realImportPath
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
mixin treeItem( node )
|
|
2
|
+
- const children = node.getChildren();
|
|
3
|
+
- const hasChildren = children && children.length > 0;
|
|
4
|
+
- let dataAttr = {};
|
|
5
|
+
|
|
6
|
+
- if ( node.getProp( 'access' ) ) dataAttr[ `data-${node.getProp('access')}` ] = 'true';
|
|
7
|
+
|
|
8
|
+
li( class= hasChildren ? "toggler--collapsed" : "" )&attributes(dataAttr)
|
|
9
|
+
- let wrapperClass = "tree__item__wrapper";
|
|
10
|
+
|
|
11
|
+
- const classStr = "tree__item--" + node.getProp( 'type' ) + " tree__item__text";
|
|
12
|
+
- const link = node.getUrl();
|
|
13
|
+
- const longname = node.getProp( 'longname' );
|
|
14
|
+
|
|
15
|
+
if !hasChildren
|
|
16
|
+
a( href=link )
|
|
17
|
+
div( class = wrapperClass data-ln = longname )
|
|
18
|
+
span( class = classStr )
|
|
19
|
+
| #{ node.getProp( 'name' ) }
|
|
20
|
+
else
|
|
21
|
+
div( class = wrapperClass data-ln = longname )
|
|
22
|
+
if ( link )
|
|
23
|
+
a( class = classStr href=link )
|
|
24
|
+
| #{ node.getProp( 'name' ) }
|
|
25
|
+
else
|
|
26
|
+
span( class = classStr )
|
|
27
|
+
| #{ node.getProp( 'name' ) }
|
|
28
|
+
ul
|
|
29
|
+
each child in children
|
|
30
|
+
+treeItem( child )
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
mixin badge( bdg )
|
|
2
|
+
= "\n"
|
|
3
|
+
|
|
4
|
+
- const classStr = `badge badge--${bdg.class} ${bdg.info ? "badge--has-invert" : ""}`;
|
|
5
|
+
|
|
6
|
+
if bdg.linkTo
|
|
7
|
+
span( class = classStr )
|
|
8
|
+
a( href= bdg.linkTo ) #{ bdg.text }
|
|
9
|
+
if bdg.info
|
|
10
|
+
| !{' '}
|
|
11
|
+
span.badge__invert #{ bdg.info }
|
|
12
|
+
|
|
13
|
+
else
|
|
14
|
+
span( class = classStr ) #{ bdg.text }
|
|
15
|
+
if bdg.info
|
|
16
|
+
| !{' '}
|
|
17
|
+
span.badge__invert #{ bdg.info }
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
include ./_link-or-text.pug
|
|
2
|
+
include ./_badge.pug
|
|
3
|
+
include ./_dev-names.pug
|
|
4
|
+
include ./_api-see-source.pug
|
|
5
|
+
|
|
6
|
+
//- todo: actually these shouldnt be collapsing-list__items
|
|
7
|
+
mixin classItem( item )
|
|
8
|
+
- const attrData = createFilterAttribs( item );
|
|
9
|
+
|
|
10
|
+
li( class="collapsing-list__item collapsing-list__item--visible" )&attributes( attrData )
|
|
11
|
+
div( class="collapsing-list__term" id=item.id )
|
|
12
|
+
h3
|
|
13
|
+
if isNonEmptyArray( item.badges )
|
|
14
|
+
p.badges
|
|
15
|
+
each badge in item.badges
|
|
16
|
+
+badge( badge )
|
|
17
|
+
|
|
18
|
+
code
|
|
19
|
+
+linkOrText( item.longname, {
|
|
20
|
+
linkText: item.name
|
|
21
|
+
} )
|
|
22
|
+
|
|
23
|
+
+devNames( item.longname )
|
|
24
|
+
|
|
25
|
+
if ( item.description && item.description.excerpt )
|
|
26
|
+
div.collapsing-list__description
|
|
27
|
+
p( class="collapsing-list__excerpt collapsing-list__excerpt--short" )
|
|
28
|
+
| !{ item.description.excerpt }
|
|
29
|
+
+seeSource( item )
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
//- Generates a full name of a member that allows creating a link from any module.
|
|
2
|
+
//-
|
|
3
|
+
//- @param {String} name The `doclet#longname` property.
|
|
4
|
+
//- @param {String|undefined} label A description of an overloaded member.
|
|
5
|
+
mixin devNames( name, label )
|
|
6
|
+
- const nameToDisplay = label ? `${ name }:${ label }` : name;
|
|
7
|
+
|
|
8
|
+
span.collapsing-list__dev-names( aria-hidden='true', title=nameToDisplay )
|
|
9
|
+
code #{ nameToDisplay }
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
include _params
|
|
2
|
+
include _type
|
|
3
|
+
include _link-or-text
|
|
4
|
+
|
|
5
|
+
mixin error( err )
|
|
6
|
+
li( class="collapsing-list__item collapsing-list__item--visible" )
|
|
7
|
+
div( class="collapsing-list__term toggler--collapsed" id=err.id )
|
|
8
|
+
h3
|
|
9
|
+
code
|
|
10
|
+
a( class="member-name" href="#" + err.id ) #{ err.name }
|
|
11
|
+
|
|
12
|
+
div.collapsing-list__description.collapsing-list__description--error-page
|
|
13
|
+
if ( err.description && err.description.excerpt )
|
|
14
|
+
p.collapsing-list__excerpt
|
|
15
|
+
| !{ err.description.excerpt }
|
|
16
|
+
|
|
17
|
+
div.collapsing-list__content
|
|
18
|
+
if ( err.description )
|
|
19
|
+
| !{ err.description.content }
|
|
20
|
+
|
|
21
|
+
if isNonEmptyArray( err.params )
|
|
22
|
+
h4 Parameters
|
|
23
|
+
+paramsMixin( err.params )
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
include ./_link-or-text.pug
|
|
2
|
+
|
|
3
|
+
mixin hierarchy-item( items )
|
|
4
|
+
- const item = items.shift();
|
|
5
|
+
- const tooltip = getApiInfoboxTooltip( item, getRealImportPath );
|
|
6
|
+
|
|
7
|
+
li( title=tooltip )
|
|
8
|
+
code
|
|
9
|
+
+linkOrText( item )
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
if ( items.length > 0 )
|
|
13
|
+
ul
|
|
14
|
+
+hierarchy-item( items )
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
//- @param {String} name
|
|
2
|
+
//- @param {Object} [options]
|
|
3
|
+
//- @param {String} [options.aClass]
|
|
4
|
+
//- @param {String} [options.linkText]
|
|
5
|
+
mixin linkOrText( name, options = {} )
|
|
6
|
+
- const extracted = extractLongname( name );
|
|
7
|
+
|
|
8
|
+
span #{ extracted.prefix }
|
|
9
|
+
each longname, index in extracted.longnames
|
|
10
|
+
- const { aClass, linkText } = options;
|
|
11
|
+
- const parts = splitLongname( longname );
|
|
12
|
+
- const linkLongname = getUrlAddressFromLongname( parts );
|
|
13
|
+
- const hashSplit = longname.split( '#' );
|
|
14
|
+
|
|
15
|
+
- const linkHashSplit = linkLongname ? linkLongname.split( '#' ) : hashSplit;
|
|
16
|
+
- const linkAutoHash = linkHashSplit.length > 1 ? linkHashSplit[ 1 ] : '';
|
|
17
|
+
- const link = longnameToUrl( linkHashSplit[ 0 ], linkAutoHash );
|
|
18
|
+
|
|
19
|
+
- let nameText = '';
|
|
20
|
+
|
|
21
|
+
if ( linkText )
|
|
22
|
+
- nameText = linkText;
|
|
23
|
+
else
|
|
24
|
+
if ( parts.className )
|
|
25
|
+
- nameText = parts.className
|
|
26
|
+
if ( parts.className !== parts.name )
|
|
27
|
+
- nameText += ( parts.isStatic ? '.' : '#' ) + parts.name
|
|
28
|
+
else
|
|
29
|
+
- nameText = parts.name || parts.longnameBase
|
|
30
|
+
if ( parts.name === 'event' && parts.label )
|
|
31
|
+
- nameText += `:${ parts.label }`
|
|
32
|
+
|
|
33
|
+
- nameText = htmlsafe( nameText );
|
|
34
|
+
|
|
35
|
+
if ( link )
|
|
36
|
+
a( class=aClass href=link.replace( 'event:', 'event-') ) !{ nameText }
|
|
37
|
+
else
|
|
38
|
+
| #{ nameText }
|
|
39
|
+
|
|
40
|
+
if index < extracted.longnames.length - 1
|
|
41
|
+
| #{ extracted.separators[ index ] }
|
|
42
|
+
|
|
43
|
+
| #{ extracted.suffix }
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
include _badge
|
|
2
|
+
include _type
|
|
3
|
+
include _params
|
|
4
|
+
include _return
|
|
5
|
+
include _fires-item
|
|
6
|
+
include _link-or-text
|
|
7
|
+
include ./_api-see-source.pug
|
|
8
|
+
include ./_dev-names.pug
|
|
9
|
+
include ./_related.pug
|
|
10
|
+
include ./type-parameter
|
|
11
|
+
|
|
12
|
+
mixin method( met )
|
|
13
|
+
- let attrData = createFilterAttribs( met );
|
|
14
|
+
- const itemClasses = [ 'collapsing-list__item', 'collapsing-list__item--visible' ];
|
|
15
|
+
|
|
16
|
+
li( class = itemClasses )&attributes( attrData )
|
|
17
|
+
- const id = encodeURI( met.id )
|
|
18
|
+
div( class="collapsing-list__term toggler--collapsed" id=id )
|
|
19
|
+
h3
|
|
20
|
+
//- badges
|
|
21
|
+
if isNonEmptyArray( met.badges )
|
|
22
|
+
p.badges
|
|
23
|
+
each badge in met.badges
|
|
24
|
+
+badge( badge )
|
|
25
|
+
|
|
26
|
+
code
|
|
27
|
+
a( class="member-name" href="#" + id ) #{ met.name }
|
|
28
|
+
|
|
29
|
+
//- params ( param1, [param2] )
|
|
30
|
+
| (
|
|
31
|
+
if isNonEmptyArray( met.params )
|
|
32
|
+
each param, index in met.params
|
|
33
|
+
if param.optional
|
|
34
|
+
| [ #{ param.name } ]
|
|
35
|
+
else
|
|
36
|
+
| #{ param.name }
|
|
37
|
+
if ( param.subParamsString )
|
|
38
|
+
//- Allow rendering HTML from the `subParamsString` as it may contain links to other pages.
|
|
39
|
+
| !{ param.subParamsString }
|
|
40
|
+
if index < met.params.length - 1
|
|
41
|
+
|,
|
|
42
|
+
else
|
|
43
|
+
| !{ ' ' }
|
|
44
|
+
| )
|
|
45
|
+
|
|
46
|
+
//- returns
|
|
47
|
+
if isNonEmptyArray( met.returns )
|
|
48
|
+
| → !{' '}
|
|
49
|
+
if isNonEmptyArray( met.returns[0].types )
|
|
50
|
+
+type( met.returns[0].types )
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
+devNames( met.longname, met.label )
|
|
54
|
+
|
|
55
|
+
div.collapsing-list__description
|
|
56
|
+
if ( met.description && met.description.excerpt )
|
|
57
|
+
div.collapsing-list__excerpt
|
|
58
|
+
p !{ met.description.excerpt }
|
|
59
|
+
|
|
60
|
+
div.collapsing-list__content
|
|
61
|
+
+seeSource( met )
|
|
62
|
+
|
|
63
|
+
if ( met.description )
|
|
64
|
+
| !{ met.description.content }
|
|
65
|
+
|
|
66
|
+
if isNonEmptyArray( met.typeParameters )
|
|
67
|
+
h4 Type parameters
|
|
68
|
+
dl
|
|
69
|
+
each type in met.typeParameters
|
|
70
|
+
+typeParameter( type )
|
|
71
|
+
|
|
72
|
+
if isNonEmptyArray( met.params )
|
|
73
|
+
h4 Parameters
|
|
74
|
+
+paramsMixin( met.params )
|
|
75
|
+
|
|
76
|
+
if isNonEmptyArray( met.returns )
|
|
77
|
+
h4 Returns
|
|
78
|
+
dl
|
|
79
|
+
each ret in met.returns
|
|
80
|
+
+return( ret )
|
|
81
|
+
|
|
82
|
+
if isNonEmptyArray( met.fires )
|
|
83
|
+
h4 Fires
|
|
84
|
+
ul
|
|
85
|
+
each longname in met.fires
|
|
86
|
+
+firesItem( longname )
|
|
87
|
+
|
|
88
|
+
if isNonEmptyArray( met.see )
|
|
89
|
+
+related( met.see )
|