Image

  • Graphics Link

Definition

<cst-img>
<sub-theme/>
<sub-font/>
<sub-style/>
<sub-access/>
<sub-area />
<sub-feature-flag/>
</cst-img>

Example

<cst-img id="" src="" alt="" usemap="" referrerpolicy="" crossorigin="" ismap="" srcset="">
<sub-theme name="" clr-var1="" clr-var2=""/>
<sub-font name="" font-var1="" font-var2=""/>
<sub-style name="" width="" height=""/>
<sub-access can-view="" can-modify=""/>
<sub-area shape="" coords="" alt="" href="" />
<sub-area shape="" coords="" alt="" href="" />
<sub-feature-flag>
</cst-img>

OR

<cst-element name="img" schema="" schema-prop=""/>

Attributes

AttributeValueDescription
idstring typeIdentifier for component.
srcstring typeSpecifies the URL of an image
altstring typeSpecifies an alternate text for an image
disabledboolean typeSpecifies if component should be disabled.(aurelia ext attribute)
crossoriginstring type(anonymous/use-credentials)Allow images from third-party sites that allow cross-origin access to be used with canvas
ismapboolean typeSpecifies an image as a server-side image-map
longdescstring typeSpecifies a URL to a detailed description of an image
referrerpolicystring type(no-referrer/no-referrer-when-downgrade/origin/origin-when-cross-origin/unsafe-url)Specifies which referrer to use when fetching the image
srcsetstring typeSpecifies the URL of the image to use in different situations
usemapstring typeSpecifies an image as a client-side image-map. This is the name of map
classstring typeSpecifies class to be applied(Multiple classes can be given with space).

sub-theme

object typeSpecifies theme to be used for component.

sub-font

object typeSpecifies fonts to be used for component.

sub-style

object typeSpecifies style to be applied to component.

sub-access

object typeSpecifies access of the component.

sub-area

object typeSpecifies area detail of the component.

sub-feature-flag

objectSpecifies what features to enable/disable.
otherany typeAny other info.
schemaobject type Specifies JSON schema.
schema-propstring typeSpecifies property to be used to pick schema.

Sub element attributes

sub-theme

PropertyValueDescription
nameprimary(default)/secondary/customName of the theme.
clr-labelstring typeIf custom then specific/ named color variables

sub-font

PropertyValueDescription
nameroboto (default)/customName of the font
font-textstring typeIf custom then specific/ named font variables.
font-labelstring type
font-errorstring type

sub-style

PropertyValueDescription
namematerial/font-awesomeName of design to be used.
widthpercentage/pixels/string(x-small,small,medium,large,x-large)Gives width/any other prop value

sub-area

PropertyValueDescription
shapestring type(rect/circle)Text to be shown as superscript
coordsstring typeSelection area coordinate on the image
altstring typeSpecifies an alternate text for an image
hrefstring typeRedirection link on click on coordinate section

sub-feature-flag

PropertyValueDescription

Schema Examples

Full schema

Fetch appropriate based on schemaProp

let schema = {
type: "object",
required: ["image"], //= required
properties: {
image: {
type: "string",
cstAttr: {
raw:{ //loop & add to element
disabled : true,
src: '',
alt: '',
crossorigin: '',
ismap: false,
longdesc: '',
referrerpolicy: '',
srcset: '',
usemap: '#<name-for-map>',
class:'outline cst-class1'
},
subStyle:{ //loop & add to element style
name: '',
width:'',
height:'',
fontSize:''
},
subFeatureFlag: {
},
subTheme:{
name:'',
clrLabel:''
},
subFont:{
name:'',
fontText:'',
fontLabel:'',
fontError:''
}
}
}
}
}
let schemaProp = 'image';
let finalSchema = schemaProp ? schema.properties[schemaProp] : schema;

Exact schema

let schema = {
type: "string", //= type 'text'
cstAttr: {
}
}
let schemaProp = '';
let finalSchema = schemaProp ? schema.properties[schemaProp] : schema;

Nested object

Nested object schemaProp

let schema = {};
let schemaProp = 'EMDDetails.image';
var finalSchema = schema;
let schemaPropSplits = schemaProp.split('.');
for(let prop of schemaPropSplits){
finalSchema = finalSchema.properties[schemaProp];
}

Material Measurement Guidelines

Events

AttributeDescription
onclickFires when the element is clicked.
onhoverFires when the element is hovered.

Event Method signature

method(parentRefObj, evtObj, elm, others)

Parameters description

ParameterValueDescription
parentRefObj
parentRefObj = {
parentContext,
loopParentContext,
doubleLoopParentContext
}
Parent Context references
evtObjobjectEvent object
elmobjectElement value
othersanyOther value

OverRidable Classes

  • cst-ovr-img-elm
  • cst-ovr-img

Unit Test Screenshots

Responsiveness Test Screenshots

Design Images

Demo link

Points

  • Display image as given value
  • event callback consistency (evtObj, elm, others,...) //check other libs