sketch-constructor/models/Text/Text.js

Read/write/manipulate Sketch files in Node without Sketch plugins!

/*
 * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

const uuid = require('uuid-v4');
const Rect = require('../Rect');
const Layer = require('../Layer');
const Style = require('../Style');
const AttributedString = require('../AttributedString');
const { textBehaviourMap } = require('../../utils/maps');
const { resizingConstraintsMap } = require('../../utils/maps.js');

/**
 * Text Layer Class
 * @extends Layer
 * @example
 * const text = new Text({
 *   string: "hello"
 * });
 */
class Text extends Layer {
  /**
   * The underlying object structure this class consists of in Sketch JSON
   * @constant
   * @type {Object}
   * @mixes Layer.Model
   * @property {boolean} automaticallyDrawOnUnderlyingPath
   * @property {boolean} dontSynchroniseWithSymbol
   */
  static get Model() {
    return {
      ...Layer.Model,
      automaticallyDrawOnUnderlyingPath: false,
      dontSynchroniseWithSymbol: false,
      attributedString: AttributedString.Model,
      glyphBounds: '{{5, 15}, {122, 55}}',
      lineSpacingBehaviour: 2,
      textBehaviour: 2,
    };
  }

  /**
   *
   * @param {Object} [args]
   * @param {Object} [args.frame] Passed to {@link Rect}
   * @param {Object} [args.style] Passsed to {@link TextStyle}
   * @param {Text.Model} [json]
   */
  constructor(args = {}, json) {
    super(args, json);
    if (!json) {
      const id = args.id || uuid().toUpperCase();
      Object.assign(this, {
        _class: 'text',
        do_objectID: id,
        booleanOperation: -1,
        automaticallyDrawOnUnderlyingPath: false,
        dontSynchroniseWithSymbol: false,
        exportOptions: {
          _class: 'exportOptions',
          exportFormats: [],
          includedLayerIds: [],
          layerOptions: 0,
          shouldTrim: false,
        },
        frame: new Rect(args.frame),
        isFixedToViewport: false,
        isFlippedHorizontal: false,
        isFlippedVertical: false,
        isLocked: false,
        isVisible: true,
        layerListExpandedType: 0,
        layers: [],
        name: args.name || id,
        nameIsFixed: false,
        resizingConstraint: resizingConstraintsMap.height,
        resizingType: 0,
        rotation: 0,
        shouldBreakMaskChain: false,
        userInfo: {},
        textBehaviour: textBehaviourMap[args.textBehaviour || 'auto'],

        style: Style.TextStyle(
          args.style || {
            fontName: args.fontName,
            fontSize: args.fontSize,
            alignment: args.alignment,
            verticalAlignment: args.verticalAlignment,
            color: args.color,
          }
        ),

        attributedString:
          args.attributedString ||
          new AttributedString({
            string: args.string || '',
            fontName: args.fontName,
            fontSize: args.fontSize,
            alignment: args.alignment,
            verticalAlignment: args.verticalAlignment,
            color: args.color,
          }),
      });
    }
  }
}

module.exports = Text;