umberto 6.0.0 → 6.1.0
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 +9 -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 +2 -2
- 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/{_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.pug +180 -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.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/{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,180 @@
|
|
|
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
|
+
//- (3) Process a single argument.
|
|
129
|
+
+renderType( paramObject )
|
|
130
|
+
if paramIndex < callback.params.length - 1
|
|
131
|
+
| !{ ', ' }
|
|
132
|
+
|
|
133
|
+
//- (4) Close the parenthesis. Define the returned type.
|
|
134
|
+
//- It prints ` ) => ` or `) => ` depending on required arguments by the callback.
|
|
135
|
+
if ( callback.params.length )
|
|
136
|
+
| !{ ' ' }) => !{ ' ' }
|
|
137
|
+
else
|
|
138
|
+
| ) => !{ ' ' }
|
|
139
|
+
|
|
140
|
+
//- Wraps the returned type in brackets to avoid confusions if a type is returned by the callback,
|
|
141
|
+
//- or it is a new type (outside the callback). See #1063.
|
|
142
|
+
if ( callback.returns instanceof Set )
|
|
143
|
+
| (!{ ' ' }
|
|
144
|
+
|
|
145
|
+
//- (5) Process the returned type that can be an union, an array of a type.
|
|
146
|
+
+renderType( callback.returns )
|
|
147
|
+
|
|
148
|
+
//- See #1063.
|
|
149
|
+
if ( callback.returns instanceof Set )
|
|
150
|
+
| !{ ' ' })
|
|
151
|
+
|
|
152
|
+
//- TODO: Description
|
|
153
|
+
//-
|
|
154
|
+
//- @param {Object} generic
|
|
155
|
+
//- @param {'generic'} generic.type
|
|
156
|
+
//- @param {String} generic.name
|
|
157
|
+
//- @param {Set.<String>} generic.names
|
|
158
|
+
//- @param {Array.<*>} [generic.typeParameters]
|
|
159
|
+
//- @param {*} [generic.typeParameter]
|
|
160
|
+
mixin renderGenericType( generic )
|
|
161
|
+
+renderType( generic.name )
|
|
162
|
+
|
|
163
|
+
if ( generic.typeParameters )
|
|
164
|
+
| !{ '<' }
|
|
165
|
+
each type, typeIndex in generic.typeParameters
|
|
166
|
+
if ( typeof type === 'string' )
|
|
167
|
+
+renderStringValue( type )
|
|
168
|
+
else
|
|
169
|
+
//- Nested generics.
|
|
170
|
+
+renderGenericType( type )
|
|
171
|
+
|
|
172
|
+
if typeIndex < generic.typeParameters.length - 1
|
|
173
|
+
| !{ ', ' }
|
|
174
|
+
| !{ '>' }
|
|
175
|
+
|
|
176
|
+
if ( generic.typeParameter )
|
|
177
|
+
| !{ '[ ' }
|
|
178
|
+
+renderType( generic.typeParameter )
|
|
179
|
+
| !{ ' ]' }
|
|
180
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
include ./_type
|
|
2
|
+
|
|
3
|
+
mixin typeParameter( type )
|
|
4
|
+
dt
|
|
5
|
+
code
|
|
6
|
+
span !{ type.name }
|
|
7
|
+
|
|
8
|
+
//- We mark most TypeScript types as `object`, as their structure is complex.
|
|
9
|
+
//- Hence, it does not really make sense to show that a type extends an unknown `object`.
|
|
10
|
+
if ( type.value && type.value[ 0 ] !== 'object' )
|
|
11
|
+
| !{' : '}
|
|
12
|
+
if ( type.isExtending )
|
|
13
|
+
i !{ 'extends ' }
|
|
14
|
+
+type( type.value )
|
|
15
|
+
|
|
16
|
+
if ( type.description )
|
|
17
|
+
dd
|
|
18
|
+
| !{ type.description.content }
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
include ../_mixin/_hierarchy-list
|
|
2
|
+
include ../_mixin/_sidebox-list
|
|
3
|
+
|
|
4
|
+
- const hasAugments = data.augments && data.augments.length > 1;
|
|
5
|
+
- const hasImplements = isNonEmptyArray( data.implements );
|
|
6
|
+
- const hasImplementedBy = isNonEmptyArray( data.implementedBy );
|
|
7
|
+
- const hasMixes = isNonEmptyArray( data.mixes );
|
|
8
|
+
- const hasMixedBy = isNonEmptyArray( data.mixedBy );
|
|
9
|
+
- const hasSubclasses = isNonEmptyArray( data.subclasses );
|
|
10
|
+
|
|
11
|
+
if ( hasAugments || hasImplements || hasImplementedBy || hasMixes || hasMixedBy || hasSubclasses )
|
|
12
|
+
nav( class="api-secondary-navigation api-info-box hidden-loading" )
|
|
13
|
+
dl
|
|
14
|
+
if ( hasAugments )
|
|
15
|
+
+hierarchyList( data.augments )
|
|
16
|
+
|
|
17
|
+
if ( hasImplements )
|
|
18
|
+
+sideboxList( data.implements, 'Implements' )
|
|
19
|
+
|
|
20
|
+
if ( hasImplementedBy )
|
|
21
|
+
+sideboxList( data.implementedBy, 'Implemented By' )
|
|
22
|
+
|
|
23
|
+
if ( hasMixes )
|
|
24
|
+
+sideboxList( data.mixes, 'Mixes' )
|
|
25
|
+
|
|
26
|
+
if ( hasMixedBy )
|
|
27
|
+
+sideboxList( data.mixedBy, 'Mixed By' )
|
|
28
|
+
|
|
29
|
+
if ( hasSubclasses )
|
|
30
|
+
+sideboxList( data.subclasses, 'Subclasses' )
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
include ../_mixin/_badge
|
|
2
|
+
|
|
3
|
+
div(class="api-subheader hidden-loading")
|
|
4
|
+
div.api-subheader__badges
|
|
5
|
+
span.badge #{ data.kind }
|
|
6
|
+
if isNonEmptyArray( data.badges )
|
|
7
|
+
each badge in data.badges
|
|
8
|
+
+badge( badge )
|
|
9
|
+
if isNonEmptyArray( data.types )
|
|
10
|
+
code
|
|
11
|
+
+type( data.types )
|
|
12
|
+
nav.api-subheader__navigation
|
|
13
|
+
if ( isNonEmptyArray( data.configOptions ) || isNonEmptyArray( data.properties ) || isNonEmptyArray( data.methods ) || isNonEmptyArray( data.events ) )
|
|
14
|
+
ul
|
|
15
|
+
if ( isNonEmptyArray( data.configOptions ) )
|
|
16
|
+
li.api-subheader__navigation-category.api-subheader__navigation-dropdown--hidden( data-type="configs" ) Config options
|
|
17
|
+
if ( isNonEmptyArray( data.properties ) )
|
|
18
|
+
li.api-subheader__navigation-category.api-subheader__navigation-dropdown--hidden( data-type="properties" ) Properties
|
|
19
|
+
if ( isNonEmptyArray( data.methods ) )
|
|
20
|
+
li.api-subheader__navigation-category.api-subheader__navigation-dropdown--hidden( data-type="methods" ) Methods
|
|
21
|
+
if ( isNonEmptyArray( data.events ) )
|
|
22
|
+
li.api-subheader__navigation-category.api-subheader__navigation-dropdown--hidden( data-type="events" ) Events
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
include ../_mixin/_property
|
|
2
|
+
|
|
3
|
+
if isNonEmptyArray( data.configOptions )
|
|
4
|
+
h2( id="config-options" class="hidden-loading" ) Config options
|
|
5
|
+
ul( class="collapsing-list collapsing-list--filtered hidden-loading" data-type="configs" )
|
|
6
|
+
each c in data.configOptions
|
|
7
|
+
+property( c )
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
div( class="notice notice__filter api-props-filter hidden-loading" )
|
|
2
|
+
div( class="api-props-filter__inner" )
|
|
3
|
+
h4 Filtering
|
|
4
|
+
ul
|
|
5
|
+
li
|
|
6
|
+
input( type="checkbox" id="f1" value="public" checked )
|
|
7
|
+
label( for="f1" )
|
|
8
|
+
span( class="badge badge--gray" ) Public
|
|
9
|
+
li
|
|
10
|
+
input( type="checkbox" id="f4" value="inherited" checked )
|
|
11
|
+
label( for="f4" )
|
|
12
|
+
span( class="badge badge--gray" ) Inherited
|
|
13
|
+
|
|
14
|
+
//- Typedoc does not support the `@mixin` concept as it is implemented in Umberto.
|
|
15
|
+
//- See: #1060.
|
|
16
|
+
if ( projectLocals.apiType !== 'typedoc' )
|
|
17
|
+
li
|
|
18
|
+
input( type="checkbox" id="f6" value="mixed" checked )
|
|
19
|
+
label( for="f6" )
|
|
20
|
+
span( class="badge badge--gray" ) Mixed
|
|
21
|
+
|
|
22
|
+
//- Typedoc supports the `@internal` annotation. See: #1057.
|
|
23
|
+
if ( projectLocals.apiType === 'typedoc' )
|
|
24
|
+
li
|
|
25
|
+
input( type="checkbox" id="f7" value="internal" checked )
|
|
26
|
+
label( for="f7" )
|
|
27
|
+
span( class="badge badge--orange" ) Internal
|
|
28
|
+
|
|
29
|
+
li
|
|
30
|
+
input( type="checkbox" id="f2" value="protected" )
|
|
31
|
+
label( for="f2" )
|
|
32
|
+
span( class="badge badge--orange" ) Protected
|
|
33
|
+
li
|
|
34
|
+
input( type="checkbox" id="f3" value="private" )
|
|
35
|
+
label( for="f3" )
|
|
36
|
+
span( class="badge badge--red" ) Private
|
|
37
|
+
li
|
|
38
|
+
input( type="checkbox" id="f5" value="deprecated" )
|
|
39
|
+
label( for="f5" )
|
|
40
|
+
span( class="badge badge--red" ) Deprecated
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
include ../_mixin/_method
|
|
2
|
+
|
|
3
|
+
if isNonEmptyArray( data.methods )
|
|
4
|
+
h2( id="methods" class="hidden-loading" ) Methods
|
|
5
|
+
if isNonEmptyArray( data.staticMethods)
|
|
6
|
+
if isNonEmptyArray( data.instanceMethods)
|
|
7
|
+
ul( class="collapsing-list collapsing-list--filtered hidden-loading" data-type="methods" )
|
|
8
|
+
each m in data.instanceMethods
|
|
9
|
+
+method( m )
|
|
10
|
+
|
|
11
|
+
h4( class="hidden-loading" ) Static methods
|
|
12
|
+
ul( class="collapsing-list collapsing-list--filtered hidden-loading" data-type="methods" )
|
|
13
|
+
each m in data.staticMethods
|
|
14
|
+
+method( m )
|
|
15
|
+
|
|
16
|
+
else
|
|
17
|
+
ul( class="collapsing-list collapsing-list--filtered hidden-loading" data-type="methods" )
|
|
18
|
+
each m in data.methods
|
|
19
|
+
+method( m )
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
include ../_mixin/_api-tree-item.pug
|
|
2
|
+
|
|
3
|
+
.side-navigation
|
|
4
|
+
.side-navigation__wrapper
|
|
5
|
+
nav.side-navigation__inner.side-navigation__inner--api
|
|
6
|
+
if projectLocals && projectLocals.apiTree
|
|
7
|
+
ul( class="tree api-tree" )
|
|
8
|
+
each node in projectLocals.apiTree.getTree().getChildren()
|
|
9
|
+
+treeItem( node )
|
|
10
|
+
div.api-tree__filter
|
|
11
|
+
p
|
|
12
|
+
input( type="checkbox" id="p1" value="public" )
|
|
13
|
+
label( for="p1" ) Show private items
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
include ../_mixin/_property
|
|
2
|
+
|
|
3
|
+
if isNonEmptyArray( data.properties )
|
|
4
|
+
h2( id="properties" class="hidden-loading" ) Properties
|
|
5
|
+
if isNonEmptyArray( data.staticProperties )
|
|
6
|
+
if isNonEmptyArray( data.instanceProperties )
|
|
7
|
+
ul( class="collapsing-list collapsing-list--filtered hidden-loading" data-type="properties" )
|
|
8
|
+
each p in data.instanceProperties
|
|
9
|
+
+property( p )
|
|
10
|
+
|
|
11
|
+
h4( class="hidden-loading" ) Static properties
|
|
12
|
+
ul( class="collapsing-list collapsing-list--filtered hidden-loading" data-type="properties" )
|
|
13
|
+
each p in data.staticProperties
|
|
14
|
+
+property( p )
|
|
15
|
+
|
|
16
|
+
else
|
|
17
|
+
ul( class="collapsing-list collapsing-list--filtered hidden-loading" data-type="properties" )
|
|
18
|
+
each p in data.properties
|
|
19
|
+
+property( p )
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
include ../_mixin/_type
|
|
2
|
+
|
|
3
|
+
if isNonEmptyArray( data.typeParameters )
|
|
4
|
+
h2( id="type-parameters" class="hidden-loading" ) Type parameters
|
|
5
|
+
|
|
6
|
+
ul( class="collapsing-list hidden-loading" )
|
|
7
|
+
each type in data.typeParameters
|
|
8
|
+
|
|
9
|
+
li( class="collapsing-list__item collapsing-list__item--visible" )
|
|
10
|
+
div( class="collapsing-list__term toggler--collapsed" class=type.description ? "" : "hidden" )
|
|
11
|
+
h3
|
|
12
|
+
code
|
|
13
|
+
span( class="member-name" ) #{ type.name }
|
|
14
|
+
|
|
15
|
+
//- We mark most TypeScript types as `object`, as their structure is complex.
|
|
16
|
+
//- Hence, it does not really make sense to show that a type extends an unknown `object`.
|
|
17
|
+
if ( type.value && type.value[ 0 ] !== 'object' )
|
|
18
|
+
| !{' : '}
|
|
19
|
+
if ( type.isExtending )
|
|
20
|
+
i !{ 'extends ' }
|
|
21
|
+
+type( type.value )
|
|
22
|
+
|
|
23
|
+
if ( type.description )
|
|
24
|
+
div.collapsing-list__description
|
|
25
|
+
div.collapsing-list__content
|
|
26
|
+
| !{ type.description.content }
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
extends ../base
|
|
2
|
+
|
|
3
|
+
block content
|
|
4
|
+
include _partial/loading-spinner
|
|
5
|
+
|
|
6
|
+
include _partial/api-subheader
|
|
7
|
+
|
|
8
|
+
include _partial/api-info-box
|
|
9
|
+
|
|
10
|
+
include _partial/description
|
|
11
|
+
|
|
12
|
+
!= filter
|
|
13
|
+
|
|
14
|
+
include _partial/config-options
|
|
15
|
+
|
|
16
|
+
include _partial/constants
|
|
17
|
+
|
|
18
|
+
include _partial/type-parameters
|
|
19
|
+
|
|
20
|
+
include _partial/properties
|
|
21
|
+
|
|
22
|
+
include _partial/methods
|
|
23
|
+
|
|
24
|
+
include _partial/events
|
|
25
|
+
|
|
26
|
+
include _partial/namespaces
|
|
27
|
+
|
|
28
|
+
include _partial/classes
|
|
29
|
+
|
|
30
|
+
include _partial/interfaces
|
|
31
|
+
|
|
32
|
+
include _partial/typedefs
|
|
33
|
+
|
|
34
|
+
include _partial/functions
|
|
35
|
+
|
|
36
|
+
block navtree
|
|
37
|
+
!= navTree
|
|
38
|
+
|
|
39
|
+
block projectVersion
|
|
40
|
+
if page.permalinkDisableDomains
|
|
41
|
+
meta( name= 'permalink-disable-domains' content=page.permalinkDisableDomains )
|
|
42
|
+
|
|
43
|
+
if projectLocals
|
|
44
|
+
meta( name= 'project-version' content= projectLocals.projectVersion )
|
|
45
|
+
meta( name= 'project-slug' content= projectLocals.projectSlug )
|
|
@@ -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/
|
|
5
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/umberto/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 + '/umberto/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/
|
|
5
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/umberto/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 + '/umberto/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
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
extends api-base
|
|
2
|
+
include ./_mixin/_api-title
|
|
3
|
+
|
|
4
|
+
block prepend content
|
|
5
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/umberto/img/box-brown.svg', kind: 'Namespace' } )
|
|
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
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
extends api-base
|
|
2
|
+
include ./_mixin/_api-title
|
|
3
|
+
include ./_mixin/_params
|
|
4
|
+
include ./_mixin/_return
|
|
5
|
+
include ./_mixin/_related
|
|
6
|
+
include ./_mixin/_link-or-text
|
|
7
|
+
|
|
8
|
+
block prepend content
|
|
9
|
+
+apiTitle( { iconPath: 'assets/' + umbertoVersion + '/umberto/img/data.svg', kind: 'Typedef' } )
|
|
10
|
+
|
|
11
|
+
block append content
|
|
12
|
+
if data.types.length == 1 && data.types[ 0 ] == 'function'
|
|
13
|
+
div.typedef-callback
|
|
14
|
+
if isNonEmptyArray( data.params )
|
|
15
|
+
h4 Parameters
|
|
16
|
+
+paramsMixin( data.params )
|
|
17
|
+
|
|
18
|
+
if isNonEmptyArray( data.returns )
|
|
19
|
+
h4 Returns
|
|
20
|
+
dl
|
|
21
|
+
each ret in data.returns
|
|
22
|
+
+return( ret )
|
|
23
|
+
|
|
24
|
+
if isNonEmptyArray( data.see )
|
|
25
|
+
+related( data.see )
|
|
26
|
+
|
|
27
|
+
if data.firedBy
|
|
28
|
+
h2 Fired by
|
|
29
|
+
ul
|
|
30
|
+
each firedByItem in data.firedBy
|
|
31
|
+
li
|
|
32
|
+
+linkOrText( firedByItem.url, { linkText: firedByItem.name } )
|
|
33
|
+
|
|
34
|
+
//- Make sure to add the report issue widget at the end of the page.
|
|
35
|
+
block append content
|
|
36
|
+
if page.reportIssueWidget
|
|
37
|
+
include ../_partial/report-issue-widget
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
mixin navTreeItem( data )
|
|
2
|
+
- const _class = page.path === data.path ? 'tree__item__wrapper tree__item__wrapper--active' : 'tree__item__wrapper';
|
|
3
|
+
- const menuTitle = data[ 'menu-title' ] || uSplitToTitleAndContent( data.content ).title || data.title;
|
|
4
|
+
li
|
|
5
|
+
a( href=relative_url( page.path, data.path ) title=menuTitle )
|
|
6
|
+
div( class=_class )
|
|
7
|
+
span( class="tree__item--guide tree__item__text" ) #{ menuTitle }
|
|
8
|
+
- if( data.shouldDisplayNewIndicator )
|
|
9
|
+
span( class="tree__item__badge tree__item__badge_new" data-badge-tooltip="New or updated content" ) New
|
|
10
|
+
- if( data.badges )
|
|
11
|
+
each badge in normalizeBadges( data )
|
|
12
|
+
span( class="tree__item__badge tree__item__badge_" + badge.name data-badge-tooltip=badge.label )
|
|
13
|
+
span( class="tree__item__badge__text" ) #{ badge.label }
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
include nav-tree-item
|
|
2
|
+
|
|
3
|
+
mixin navTreeLevel( data, isRoot )
|
|
4
|
+
- if ( !data ) return;
|
|
5
|
+
- const pages = site.pages.filter( getPagesForNavTree( data.id, page.projectName ) );
|
|
6
|
+
- const categories = data.categories ? markEmptyCategories( { pages: site.pages, categories: data.categories, projectName: page.projectName, group: page.groupId } ) : [];
|
|
7
|
+
- let dataArr = [].concat( pages.toArray(), categories ).sort( ( a, b ) => ( a.title || a.name ).localeCompare( b.title || b.name ) );
|
|
8
|
+
- dataArr.forEach( ( item, idx ) => { item.index = idx; } );
|
|
9
|
+
//- Default order value is 0, some categories might not have assigned value that's why there is fallback to default value.
|
|
10
|
+
- dataArr.sort( ( a, b ) => ( a.order || 0 ) === ( b.order || 0 ) ? a.index - b.index : ( a.order || 0 ) - ( b.order || 0 ) );
|
|
11
|
+
- const shouldPrintSubTree = dataArr.filter( item => item.title || item.hasDescendentLeaf ).length || projectLocals.navigationShowEmptyCategories
|
|
12
|
+
|
|
13
|
+
if isRoot
|
|
14
|
+
if data.navigationIncludeIndex
|
|
15
|
+
+navTreeItem( findMainCategoryPage( data.id, page.projectName, site.pages ) )
|
|
16
|
+
|
|
17
|
+
each item in dataArr
|
|
18
|
+
if item.name
|
|
19
|
+
+navTreeLevel( item, false )
|
|
20
|
+
else
|
|
21
|
+
+navTreeItem( item )
|
|
22
|
+
|
|
23
|
+
//- We don't want to display empty categories (#523).
|
|
24
|
+
else if shouldPrintSubTree
|
|
25
|
+
li
|
|
26
|
+
div.tree__item__wrapper
|
|
27
|
+
span( class="tree__item--folder tree__item__text" ) #{ data.name }
|
|
28
|
+
- if( data.badges )
|
|
29
|
+
each badge in normalizeBadges( data )
|
|
30
|
+
span( class="tree__item__badge tree__item__badge_" + badge.name data-badge-tooltip=badge.label )
|
|
31
|
+
span( class="tree__item__badge__text" ) #{ badge.label }
|
|
32
|
+
ul( class={ "tree__item-nested-list": true, "tree__item-nested-list--hidden": data.folded } data-id=data.id )
|
|
33
|
+
each item in dataArr
|
|
34
|
+
//- Categories have a property 'name', guides don't have property 'name'.
|
|
35
|
+
if item.name
|
|
36
|
+
+navTreeLevel( item, false )
|
|
37
|
+
else
|
|
38
|
+
+navTreeItem( item )
|