Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add border styling options for structured content images #577

Merged
merged 2 commits into from
Jan 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions ext/data/schemas/dictionary-term-bank-v3-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
},
"height": {
"type": "number",
"description": "Preferred width of the image.",
"description": "Preferred height of the image.",
"minimum": 0
},
"title": {
Expand Down Expand Up @@ -204,6 +204,14 @@
"description": "The vertical alignment of the image.",
"enum": ["baseline", "sub", "super", "text-top", "text-bottom", "middle", "top", "bottom"]
},
"border": {
"type": "string",
"description": "Shorthand for border width, style, and color."
},
"borderRadius": {
"type": "string",
"description": "Roundness of the corners of the image's outer border edge."
},
"sizeUnits": {
"type": "string",
"description": "The units for the width and height.",
Expand Down Expand Up @@ -485,7 +493,7 @@
},
"height": {
"type": "integer",
"description": "Preferred width of the image.",
"description": "Preferred height of the image.",
"minimum": 1
},
"title": {
Expand Down
9 changes: 8 additions & 1 deletion ext/js/dictionary/dictionary-importer.js
Original file line number Diff line number Diff line change
Expand Up @@ -486,9 +486,16 @@ export class DictionaryImporter {
* @param {import('dictionary-database').DatabaseTermEntry} entry
*/
async _resolveStructuredContentImage(context, target, source, entry) {
const {verticalAlign, sizeUnits} = source;
const {
verticalAlign,
border,
borderRadius,
sizeUnits
} = source;
await this._createImageData(context, target, source, entry);
if (typeof verticalAlign === 'string') { target.verticalAlign = verticalAlign; }
if (typeof border === 'string') { target.border = border; }
if (typeof borderRadius === 'string') { target.borderRadius = borderRadius; }
if (typeof sizeUnits === 'string') { target.sizeUnits = sizeUnits; }
}

Expand Down
4 changes: 4 additions & 0 deletions ext/js/display/sandbox/structured-content-generator.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ export class StructuredContentGenerator {
collapsed,
collapsible,
verticalAlign,
border,
borderRadius,
sizeUnits
} = data;

Expand Down Expand Up @@ -130,6 +132,8 @@ export class StructuredContentGenerator {
}

imageContainer.style.width = `${usedWidth}em`;
if (typeof border === 'string') { imageContainer.style.border = border; }
if (typeof borderRadius === 'string') { imageContainer.style.borderRadius = borderRadius; }
if (typeof title === 'string') {
imageContainer.title = title;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
"Image alt text tests.\n𬵪 = Unicode character\n",
{"tag": "img", "alt": "𬵪", "path": "aosaba_mono.png", "height": 1.0, "width": 1.0, "background": false, "sizeUnits": "em", "collapsed": false, "collapsible": false, "appearance": "monochrome"},
" = monochrome PNG\n",
{"tag": "img", "alt": "𬵪", "path": "aosaba_auto.png", "height": 1.0, "width": 1.0, "background": false, "sizeUnits": "em", "collapsed": false, "collapsible": false, "appearance": "auto"},
{"tag": "img", "alt": "𬵪", "path": "aosaba_auto.png", "height": 1.0, "width": 1.0, "background": false, "sizeUnits": "em", "collapsed": false, "collapsible": false, "appearance": "auto", "borderRadius": "20%", "border": "solid 1px red"},
" = color PNG"
]},
{"type": "structured-content", "content": [
Expand Down
2 changes: 2 additions & 0 deletions types/ext/dictionary-data.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ export type TermGlossaryDeinflection = [
export type TermImage = StructuredContent.ImageElementBase & {
// Compatibility properties
verticalAlign?: undefined;
border?: undefined;
borderRadius?: undefined;
sizeUnits?: undefined;
};

Expand Down
14 changes: 12 additions & 2 deletions types/ext/structured-content.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ export type ImageAppearance = 'auto' | 'monochrome';

export type Image = DictionaryData.TermImage & {
verticalAlign: VerticalAlign;
border: string;
borderRadius: string;
sizeUnits: SizeUnits;
};

Expand Down Expand Up @@ -142,7 +144,7 @@ export type ImageElementBase = {
*/
width?: number;
/**
* Preferred width of the image.
* Preferred height of the image.
*/
height?: number;
/**
Expand All @@ -151,7 +153,7 @@ export type ImageElementBase = {
*/
preferredWidth?: number;
/**
* Preferred width of the image.
* Preferred height of the image.
* This is only used in the internal database.
*/
preferredHeight?: number;
Expand Down Expand Up @@ -203,6 +205,14 @@ export type ImageElement = ImageElementBase & {
* The vertical alignment of the image.
*/
verticalAlign?: VerticalAlign;
/**
* Shorthand for border width, style, and color.
*/
border?: string;
/**
* Roundness of the corners of the image's outer border edge.
*/
borderRadius?: string;
/**
* The units for the width and height.
*/
Expand Down
Loading