@pndr/record-gallery-card NPM

RecordGalleryCard

Used for displaying a record as a gallery card.

RecordGalleryCard

Getting started

npm install @cmds/record-gallery-card --save

Prop Types

Property	Type	Required?	Description
id	String	✓	Unique id for the instance of this record
name	String	✓	Name for the record
coverAttachments	Array		Each attachment be displayed in a the card's cover as a carousel
coverFitTypeId	CoverFitType		Either `crop` or `fit`. The images inside the cover will be either covered or contained, respectively
coverEnabled	Boolean	✓	Whether the cover should be displayed or not
fields	Array	✓	List of field objects containing the name and more information for each field.
visibleFieldOrder	Array	✓	A list of ids for the fields that need to be displayed and in which order
fieldHeightGetter	Function	✓	Responsible for returning the height for the field: `({field: object}): number`
fieldRenderer	Function	✓	Responsible for rendering a field given it's configuration: `({recordId: string, index: number, field: object}): jsx` Learn more
onClick	Function	✓	Triggers when the user clicks the record gallery card: `({id: string, e: ClickEvent})`

fieldRenderer

Responsible for rendering a field given it's configuration.

import SingleLineTextField from '@cmds/single-line-text-field'
// import all other fields that need to be supported...

const renderers = {
    singleLineText: ({props}) => (
        <SingleLineTextField
            {...props}
            text={'Luke Skywalker'}
            onChange={({id, text}) => {
                
                // store new value
            }}
        />
    ),
    // and all other fields that need to be supported
}

function fieldRenderer({id, index, field, props}) {

    const renderer = renderers[field.typeId]
    
    if (!renderer) {
        throw new Error(`Renderer for typeId '${field.typeId}' not found`)
    }
    
    /**
     * Note — props already contains properties
     * related to the context in which the field
     * gets rendered.
     * 
     * {
     *      id: 'fld1', // the field's id
     *      contextId: 'recordGalleryCard',
     *      roleId: 'readOnly'
     * }
     */
    
    return renderer({ 
        id, 
        field,
        props
    })
}