umberto 1.16.0 → 2.0.0

package/themes/umberto/src/css/styles.scss

@@ -1,9 +1,13 @@
-// Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+// Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
 // For licensing, see LICENSE.md or http://ckeditor.com/license
 
-@import '~tippy.js/dist/tippy.css';
-@import '~tippy.js/themes/light-border.css';
-@import '~tippy.js/animations/scale.css';
+// Division using / is deprecated, math.div() has to be used instead.
+// See: https://sass-lang.com/documentation/breaking-changes/slash-div
+@use 'sass:math';
+
+@use '~tippy.js/dist/tippy.css';
+@use '~tippy.js/themes/light-border.css';
+@use '~tippy.js/animations/scale.css';
 
 @import 'helpers/globals';
 @import 'helpers/font';
@@ -29,7 +33,7 @@ body, html {
 
 body {
 	padding: $u-top-height 0 0;
-	color: u-color( text, 10 );
+	color: u-color( text, 10% );
 
 	@include u-responsive-tablet {
 		padding: $u-top-main 0 0;
@@ -49,6 +53,10 @@ a {
 	}
 }
 
+.hidden-loading {
+	display: none;
+}
+
 @import 'tree';
 @import 'top';
 @import 'main';
@@ -60,6 +68,7 @@ a {
 @import 'dropdown';
 @import 'secondary-navigation';
 @import 'docsearch';
+@import 'loading-spinner';
 // PAGES
 
 // GUIDES

package/themes/umberto/src/js/_anchors.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_apisearch.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_apitree.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_collapsables.js

@@ -1,14 +1,14 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 
 import $ from 'jquery';
 
-export function enableCollapsables() {
-	const classExp = 'toggler--expanded';
-	const classCol = 'toggler--collapsed';
+const classExp = 'toggler--expanded';
+const classCol = 'toggler--collapsed';
 
+export function enableCollapsables() {
 	enableCollapsable( {
 		selector: '.tree li[class*="toggler--"]',
 		nodeElement: 'li',
@@ -35,6 +35,10 @@ function enableCollapsable( options ) {
 		const parentNode = target.closest( options.nodeElement );
 
 		if ( parentNode.is( options.selector ) ) {
+			if ( hasClassFrom( target, 'hidden' ) || hasClassFrom( target.parent(), 'hidden' ) ) {
+				return;
+			}
+
 			if ( ( target.is( 'a' ) || target.is( 'code' ) ) && hasClassFrom( target, options.dontToggleClass ) ) {
 				return;
 			}
@@ -63,20 +67,40 @@ export function hideTogglers() {
 		const excerpt = $( this ).find( '.collapsing-list__excerpt' );
 		const term = $( this ).children( '.collapsing-list__term' );
 
+		const hasExcerpt = excerpt.length > 0;
+
 		// If there is no excerpt it means that API item has no description at all so we can hide the toggler.
-		if ( excerpt.length === 0 ) {
+		if ( !hasExcerpt ) {
+			term.addClass( 'hidden' );
+
+			return;
+		}
+
+		const isExcerptShort = $( this ).find( '.collapsing-list__excerpt--short' ).length > 0;
+
+		// Short excerpts have no togglers in the first place.
+		if ( isExcerptShort ) {
+			return;
+		}
+
+		// Check whether short description is cut off by an ellipsis due to available space being too narrow.
+		const excerptParagraph = $( this ).find( '.collapsing-list__excerpt p' );
+		// Some elements have no short description, eg.:
+		// api/module_basic-styles_attributecommand-AttributeCommand.html#function-constructor
+		const excerptHasEllipsis = !excerptParagraph.length ? false :
+			Math.abs( excerptParagraph[ 0 ].clientWidth - excerptParagraph[ 0 ].scrollWidth ) > 0;
+
+		// Check whether there is any content in the extended description.
+		const hasContent = $( this ).find( '.collapsing-list__content' ).text().trim().length > 0;
+
+		// Check whether there is a link to the source code.
+		const hasSourceLink = $( this ).find( '.see-source' ).length > 0;
+
+		// If none of the criteria above is met, toggler is not needed and can be hidden away.
+		if ( !excerptHasEllipsis && !hasContent && !hasSourceLink ) {
+			term.removeClass( classCol );
+			term.addClass( classExp );
 			term.addClass( 'hidden' );
-		} else {
-			const el = excerpt[ 0 ];
-			// Checking absolute value between scrollWidth and offsetWidth becaue when window is zoomed out these values differ by 1.
-			const excerptHasEllipsis = Math.abs( el.scrollWidth - el.offsetWidth ) > 3;
-			const descriptionContent = $( this ).find( '.collapsing-list__content' );
-
-			// If excerpt has no ellipsis, which means it's short, and item detailed description is empty.
-			// Then we also can hide the toggler.
-			if ( !excerptHasEllipsis && !descriptionContent.text().trim() ) {
-				term.addClass( 'hidden' );
-			}
 		}
 	} );
 }

package/themes/umberto/src/js/_copymobileapinavigation.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_devnames.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_dropdowns.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_filtering.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 
@@ -16,10 +16,10 @@ export function enableFiltering() {
 		tree: 'filtering:tree'
 	};
 
-	enableProperiesFiltering();
+	enablePropertiesFiltering();
 	enableTreeFiltering();
 
-	function enableProperiesFiltering() {
+	function enablePropertiesFiltering() {
 		$( '.api-props-filter input' )
 			.on( 'change', applyFilterConfig )
 			.on( 'change', saveFilterSetting );
@@ -35,10 +35,14 @@ export function enableFiltering() {
 		function applyFilterConfig() {
 			const cfg = getFilterConfig().toArray();
 			const visibleClass = 'collapsing-list__item--visible';
+			const hiddenLoadingClass = 'hidden-loading';
 			const emptyClass = 'collapsing-list--empty';
 			const firstItemClass = 'collapsing-list__item--first';
 			const dropdownHiddenClass = 'api-subheader__navigation-dropdown--hidden';
 
+			$( '.loading' ).addClass( hiddenLoadingClass );
+			$( `.main__content--api .${ hiddenLoadingClass }:not(.loading)` ).removeClass( hiddenLoadingClass );
+
 			$( `.collapsing-list__item.${ visibleClass }` ).removeClass( `${ visibleClass } ${ firstItemClass }` );
 			$( '.collapsing-list' ).removeClass( emptyClass );
 
@@ -73,6 +77,7 @@ export function enableFiltering() {
 					}
 				}
 			} );
+
 			// Refresh dropdown classes and visibility
 			window.umberto.updateDropdowns();
 		}

package/themes/umberto/src/js/_imageModal.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_pagenavigation.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_prism.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_rwdmenu.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_samplecode.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_sidenavigation.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_toc.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_tooltips.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/_warningbanner.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
 

package/themes/umberto/src/js/app.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2017-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2017-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */