Merge pull request #1180 from mathjax/rename-stylelist

Rename StyleList to StyleJson, etc.

Author: dpvc

testsuite/tests/util/StyleList.test.ts testsuite/tests/util/StyleJson.test.tstestsuite/tests/util/StyleList.test.ts renamed to testsuite/tests/util/StyleJson.test.ts

@@ -1,12 +1,12 @@
 import { describe, test, expect } from '@jest/globals';
-import {CssStyles} from '#js/util/StyleList.js';
+import {StyleJsonSheet} from '#js/util/StyleJson.js';
 
-describe('CssStyles object', () => {
+describe('StyleJsonSheet object', () => {
 
   test('CssStyle creation', () => {
-    expect(new CssStyles().cssText).toBe('');
-    expect(new CssStyles({'.mjx': {padding: '0px'}}).cssText).toBe('.mjx {\n  padding: 0px;\n}');
-    expect(new CssStyles({
+    expect(new StyleJsonSheet().cssText).toBe('');
+    expect(new StyleJsonSheet({'.mjx': {padding: '0px'}}).cssText).toBe('.mjx {\n  padding: 0px;\n}');
+    expect(new StyleJsonSheet({
       '.mjx': {
         padding: '0px',
         'font-size': '150%'
@@ -27,7 +27,7 @@ describe('CssStyles object', () => {
   });
 
   test('Add/remove styles', () => {
-    const styles = new CssStyles();
+    const styles = new StyleJsonSheet();
     styles.addStyles({p: {'font-weight': 'bold'}, h1: {'font-size': '150%'}, 'h2': {}});
     expect(styles.cssText).toBe('p {\n  font-weight: bold;\n}\n\nh1 {\n  font-size: 150%;\n}\n\nh2 {\n\n}');
     styles.removeStyles('h1', 'h2');

ts/a11y/assistive-mml.ts

@@ -36,7 +36,7 @@ import {
 import { MmlNode } from '../core/MmlTree/MmlNode.js';
 import { SerializedMmlVisitor } from '../core/MmlTree/SerializedMmlVisitor.js';
 import { OptionList, expandable } from '../util/Options.js';
-import { StyleList } from '../util/StyleList.js';
+import { StyleJson } from '../util/StyleJson.js';
 
 /*==========================================================================*/
 
@@ -209,7 +209,7 @@ export function AssistiveMmlMathDocumentMixin<
     /**
      * styles needed for the hidden MathML
      */
-    public static assistiveStyles: StyleList = {
+    public static assistiveStyles: StyleJson = {
       'mjx-assistive-mml': {
         position: 'absolute !important',
         top: '0px',

ts/a11y/explorer/Region.ts

@@ -22,7 +22,7 @@
  */
 
 import { MathDocument } from '../../core/MathDocument.js';
-import { CssStyles } from '../../util/StyleList.js';
+import { StyleJsonSheet } from '../../util/StyleJson.js';
 import * as Sre from '../sre.js';
 import { SsmlElement, buildSpeech } from '../speech/SpeechUtil.js';
 
@@ -83,9 +83,9 @@ export abstract class AbstractRegion<T> implements Region<T> {
   /**
    * The CSS style that needs to be added for this type of region.
    *
-   * @type {CssStyles}
+   * @type {StyleJsonSheet}
    */
-  protected static style: CssStyles;
+  protected static style: StyleJsonSheet;
 
   /**
    * The outer div node.
@@ -319,7 +319,7 @@ export class ToolTip extends StringRegion {
   /**
    * @override
    */
-  protected static style: CssStyles = new CssStyles({
+  protected static style: StyleJsonSheet = new StyleJsonSheet({
     ['.' + ToolTip.className]: {
       width: 'auto',
       height: 'auto',
@@ -345,7 +345,7 @@ export class LiveRegion extends StringRegion {
   /**
    * @override
    */
-  protected static style: CssStyles = new CssStyles({
+  protected static style: StyleJsonSheet = new StyleJsonSheet({
     ['.' + LiveRegion.className]: {
       position: 'absolute',
       top: 0,
@@ -537,7 +537,7 @@ export class HoverRegion extends AbstractRegion<HTMLElement> {
   /**
    * @override
    */
-  protected static style: CssStyles = new CssStyles({
+  protected static style: StyleJsonSheet = new StyleJsonSheet({
     ['.' + HoverRegion.className]: {
       display: 'block',
       position: 'absolute',

ts/handlers/html/HTMLDocument.ts

@@ -34,7 +34,7 @@ import { HTMLDomStrings } from './HTMLDomStrings.js';
 import { DOMAdaptor } from '../../core/DOMAdaptor.js';
 import { InputJax } from '../../core/InputJax.js';
 import { STATE, ProtoItem, Location } from '../../core/MathItem.js';
-import { StyleList } from '../../util/StyleList.js';
+import { StyleJson } from '../../util/StyleJson.js';
 
 /*****************************************************************/
 /**
@@ -81,7 +81,7 @@ export class HTMLDocument<N, T, D> extends AbstractMathDocument<N, T, D> {
   /**
    * Extra styles to be included in the document's stylesheet (added by extensions)
    */
-  protected styles: StyleList[];
+  protected styles: StyleJson[];
 
   /**
    * The DomString parser for locating the text in DOM trees
@@ -115,7 +115,7 @@ export class HTMLDocument<N, T, D> extends AbstractMathDocument<N, T, D> {
    * @param {number} index         The position within the N's string that needs to be found
    * @param {string} delim         The delimiter for this position
    * @param {HTMLNodeArray} nodes  The list of node lists representing the string array
-   * @returns {Location}            The Location object for the position of the delimiter in the document
+   * @returns {Location}           The Location object for the position of the delimiter in the document
    */
   protected findPosition(
     N: number,
@@ -143,7 +143,7 @@ export class HTMLDocument<N, T, D> extends AbstractMathDocument<N, T, D> {
    * @param {ProtoItem} item       The proto math item to turn into an actual MathItem
    * @param {InputJax} jax         The input jax to use for the MathItem
    * @param {HTMLNodeArray} nodes  The array of node lists that produced the string array
-   * @returns {HTMLMathItem}        The MathItem for the given proto item
+   * @returns {HTMLMathItem}       The MathItem for the given proto item
    */
   protected mathItem(
     item: ProtoItem<N, T>,
@@ -208,7 +208,7 @@ export class HTMLDocument<N, T, D> extends AbstractMathDocument<N, T, D> {
    *
    * @param {InputJax<N,T,D>} jax    The jax being used
    * @param {N[]} containers         The containers to be searched in order
-   * @returns {HTMLMathList<N,T,D>}   The list of MathItems found
+   * @returns {HTMLMathList<N,T,D>}  The list of MathItems found
    */
   protected findMathFromStrings(
     jax: InputJax<N, T, D>,
@@ -233,7 +233,7 @@ export class HTMLDocument<N, T, D> extends AbstractMathDocument<N, T, D> {
    *
    * @param {InputJax<N,T,D>} jax    The jax being used
    * @param {N[]} containers         The containers to be searched in order
-   * @returns {HTMLMathList<N,T,D>}   The list of MathItems found
+   * @returns {HTMLMathList<N,T,D>}  The list of MathItems found
    */
   protected findMathFromDOM(
     jax: InputJax<N, T, D>,
@@ -345,16 +345,16 @@ export class HTMLDocument<N, T, D> extends AbstractMathDocument<N, T, D> {
   /**
    * Add styles to be included in the document's stylesheet
    *
-   * @param {StyleList} styles   The styles to include
+   * @param {StyleJson} styles   The styles to include
    */
-  public addStyles(styles: StyleList) {
+  public addStyles(styles: StyleJson) {
     this.styles.push(styles);
   }
 
   /**
-   * @returns {StyleList[]} Get the array of document-specific styles
+   * @returns {StyleJson[]}   The array of document-specific styles
    */
-  public getStyles(): StyleList[] {
+  public getStyles(): StyleJson[] {
     return this.styles;
   }
 }

ts/output/chtml.ts

@@ -24,7 +24,7 @@
 import { CommonOutputJax } from './common.js';
 import { CommonWrapper as _CommonWrapper } from './common/Wrapper.js';
 import { StyleList } from '../util/Styles.js';
-import { StyleList as CssStyleList, CssStyles } from '../util/StyleList.js';
+import { StyleJson, StyleJsonSheet } from '../util/StyleJson.js';
 import { OptionList } from '../util/Options.js';
 import { MathDocument } from '../core/MathDocument.js';
 import { MathItem } from '../core/MathItem.js';
@@ -91,7 +91,7 @@ export class CHTML<N, T, D> extends CommonOutputJax<
   /**
    *  The default styles for CommonHTML
    */
-  public static commonStyles: CssStyleList = {
+  public static commonStyles: StyleJson = {
     ...CommonOutputJax.commonStyles,
     'mjx-container[jax="CHTML"]': {
       'white-space': 'nowrap',
@@ -219,7 +219,7 @@ export class CHTML<N, T, D> extends CommonOutputJax<
    */
   public styleSheet(html: MathDocument<N, T, D>) {
     if (this.chtmlStyles) {
-      const styles = new CssStyles();
+      const styles = new StyleJsonSheet();
       if (this.options.adaptiveCSS) {
         //
         // Update the style sheet rules
@@ -238,16 +238,16 @@ export class CHTML<N, T, D> extends CommonOutputJax<
   }
 
   /**
-   * @param {CssStyles} styles   The styles to update with newly used character styles
+   * @param {StyleJsonSheet} styles   The styles to update with newly used character styles
    */
-  protected updateFontStyles(styles: CssStyles) {
+  protected updateFontStyles(styles: StyleJsonSheet) {
     styles.addStyles(this.font.updateStyles({}));
   }
 
   /**
    * @override
    */
-  protected addWrapperStyles(styles: CssStyles) {
+  protected addWrapperStyles(styles: StyleJsonSheet) {
     if (!this.options.adaptiveCSS) {
       super.addWrapperStyles(styles);
       return;
@@ -265,7 +265,10 @@ export class CHTML<N, T, D> extends CommonOutputJax<
   /**
    * @override
    */
-  protected addClassStyles(wrapper: typeof _CommonWrapper, styles: CssStyles) {
+  protected addClassStyles(
+    wrapper: typeof _CommonWrapper,
+    styles: StyleJsonSheet
+  ) {
     const CLASS = wrapper as typeof ChtmlWrapper;
     if (CLASS.autoStyle && CLASS.kind !== 'unknown') {
       styles.addStyles({
@@ -291,7 +294,7 @@ export class CHTML<N, T, D> extends CommonOutputJax<
    * Clear the cache of which items need their styles to be output
    */
   public clearCache() {
-    this.cssStyles.clear();
+    this.styleJson.clear();
     this.font.clearCache();
     this.wrapperUsage.clear();
     this.chtmlStyles = null;