Add BuilderElement and lang

This commit is contained in:
Dolan
2022-12-18 00:52:29 +00:00
parent af3b7f2613
commit 03d5152e7c
4 changed files with 105 additions and 5 deletions

View File

@ -2,6 +2,7 @@ import { BorderElement, IBorderOptions } from "@file/border";
import { IShadingAttributesProperties, Shading } from "@file/shading"; import { IShadingAttributesProperties, Shading } from "@file/shading";
import { ChangeAttributes, IChangedAttributesProperties } from "@file/track-revision/track-revision"; import { ChangeAttributes, IChangedAttributesProperties } from "@file/track-revision/track-revision";
import { import {
BuilderElement,
HpsMeasureElement, HpsMeasureElement,
IgnoreIfEmptyXmlComponent, IgnoreIfEmptyXmlComponent,
NumberValueElement, NumberValueElement,
@ -51,6 +52,16 @@ export interface IRunStylePropertiesOptions {
readonly emboss?: boolean; readonly emboss?: boolean;
readonly imprint?: boolean; readonly imprint?: boolean;
readonly revision?: IRunPropertiesChangeOptions; readonly revision?: IRunPropertiesChangeOptions;
// <xsd:complexType name="CT_Language">
// <xsd:attribute name="val" type="s:ST_Lang" use="optional"/>
// <xsd:attribute name="eastAsia" type="s:ST_Lang" use="optional"/>
// <xsd:attribute name="bidi" type="s:ST_Lang" use="optional"/>
// </xsd:complexType>
readonly language?: {
readonly value?: string;
readonly eastAsia?: string;
readonly bidirectional?: string;
};
readonly border?: IBorderOptions; readonly border?: IBorderOptions;
readonly vanish?: boolean; readonly vanish?: boolean;
readonly specVanish?: boolean; readonly specVanish?: boolean;
@ -240,6 +251,32 @@ export class RunProperties extends IgnoreIfEmptyXmlComponent {
if (options.scale !== undefined) { if (options.scale !== undefined) {
this.push(new NumberValueElement("w:w", options.scale)); this.push(new NumberValueElement("w:w", options.scale));
} }
if (options.language) {
this.push(
new BuilderElement<{
readonly value: string;
readonly eastAsia: string;
readonly bidirectional: string;
}>({
name: "w:lang",
attributes: {
value: {
key: "w:val",
value: options.language.value,
},
eastAsia: {
key: "w:eastAsia",
value: options.language.eastAsia,
},
bidirectional: {
key: "w:bidi",
value: options.language.bidirectional,
},
},
}),
);
}
} }
public push(item: XmlComponent): void { public push(item: XmlComponent): void {

View File

@ -580,5 +580,35 @@ describe("Run", () => {
}); });
}); });
}); });
describe("#language", () => {
it("should correctly set the language", () => {
const run = new Run({
language: {
value: "en-US",
eastAsia: "zh-CN",
bidirectional: "ar-SA",
},
});
const tree = new Formatter().format(run);
expect(tree).to.deep.equal({
"w:r": [
{
"w:rPr": [
{
"w:lang": {
_attr: {
"w:val": "en-US",
"w:eastAsia": "zh-CN",
"w:bidi": "ar-SA",
},
},
},
],
},
],
});
});
});
}); });
}); });

View File

@ -3,14 +3,20 @@ import { IXmlableObject } from "./xmlable-object";
export type AttributeMap<T> = { readonly [P in keyof T]: string }; export type AttributeMap<T> = { readonly [P in keyof T]: string };
export type AttributeData = { readonly [key: string]: boolean | number | string };
export type AttributePayload<T extends AttributeData> = Record<
keyof T,
{
readonly key: string;
readonly value?: T[keyof T];
}
>;
export abstract class XmlAttributeComponent<T extends object> extends BaseXmlComponent { export abstract class XmlAttributeComponent<T extends object> extends BaseXmlComponent {
// tslint:disable-next-line:readonly-keyword
protected readonly root: T;
protected readonly xmlKeys?: AttributeMap<T>; protected readonly xmlKeys?: AttributeMap<T>;
public constructor(properties: T) { public constructor(private readonly root: T) {
super("_attr"); super("_attr");
this.root = properties;
} }
public prepForXml(_: IContext): IXmlableObject { public prepForXml(_: IContext): IXmlableObject {
@ -26,3 +32,20 @@ export abstract class XmlAttributeComponent<T extends object> extends BaseXmlCom
return { _attr: attrs }; return { _attr: attrs };
} }
} }
export class NextAttributeComponent<T extends AttributeData> extends BaseXmlComponent {
public constructor(private readonly root: AttributePayload<T>) {
super("_attr");
}
public prepForXml(_: IContext): IXmlableObject {
const attrs = {};
Object.values(this.root).forEach(({ key, value }) => {
if (value !== undefined) {
// eslint-disable-next-line functional/immutable-data
attrs[key] = value;
}
});
return { _attr: attrs };
}
}

View File

@ -1,4 +1,4 @@
import { Attributes, XmlComponent } from "@file/xml-components"; import { AttributeData, AttributePayload, Attributes, NextAttributeComponent, XmlComponent } from "@file/xml-components";
import { hpsMeasureValue } from "@util/values"; import { hpsMeasureValue } from "@util/values";
@ -70,3 +70,13 @@ export class StringContainer extends XmlComponent {
this.root.push(val); this.root.push(val);
} }
} }
export class BuilderElement<T extends AttributeData> extends XmlComponent {
public constructor(options: { readonly attributes?: AttributePayload<T>; readonly name: string }) {
super(options.name);
if (options.attributes) {
this.root.push(new NextAttributeComponent(options.attributes));
}
}
}