All files / src/components/form/form-label FormLabel.ts

80% Statements 8/10
0% Branches 0/10
66.67% Functions 2/3
80% Lines 8/10

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 1071x 1x   1x   1x   1x       1x         1x                                                                                                                                                                                   1x
import CustomElement from "../../../custom-element/CustomElement";
import defineCustomElement from "../../../custom-element/helpers/defineCustomElement";
import { CustomElementPropertyMetadata } from "../../../custom-element/interfaces";
import html  from "../../../renderer/html";
import { NodePatchingData } from "../../../renderer/NodePatcher";
import styles from "./FormLabel.css";
 
export default class FormLabel extends CustomElement {
 
    static get styles(): string {
 
        return styles as any;
    }
 
    static get properties(): Record<string, CustomElementPropertyMetadata> {
 
        return {
 
            /** 
             * Whether the form field is required
             * If true it sets a field indicator as required and adds a required validator to the field
             */
            required: {
                type: Boolean,
                reflect: true,
                value: false
            },
 
            /** 
             * Whether the form field is modified to show it on the label
             */
            modified: {
                type: Boolean,
                reflect: true,
                value: false
            },
 
            /**
             * Content justification
             */
            justifyContent: {
                attribute: 'justify-content',
                type: String,
                value: 'space-evenly',
                options: ['start', 'center', 'space-around', 'space-between', 'space-evenly'],
                reflect: true,
                inherit: true
            },
 
            /**
             * The key to retrieve a localized help value from an i18n provider
             */
            helpResourceKey: {
                attribute: 'help-resource-key',
                type: String
            },
 
            /**
             * The help content
             */
            help: {
                type: String
            }
        };
    }
 
    render(): NodePatchingData {
 
        const {
            required,
            helpResourceKey,
            help,
            modified
        } = this;
 
        return html`<gcl-row justify-content=${this.justifyContent}>
            <slot name="label"></slot> 
            ${helpResourceKey !== undefined || help !== undefined ?
                html`<gcl-tool-tip>
                    <gcl-badge kind="primary" slot="trigger">
                        <span>?</span>
                    </gcl-badge>
                    <gcl-localized-text resource-key=${helpResourceKey} slot="content">${help || ''}</gcl-localized-text>
                </gcl-tool-tip>`
                : null}   
            ${required === true ?
                html`<gcl-tool-tip>
                    <gcl-badge kind="danger" slot="trigger">
                        <span>*</span>
                    </gcl-badge>
                    <gcl-localized-text resource-key="thisFieldIsRequired" slot="content">This field is required</gcl-localized-text>
                </gcl-tool-tip>`
                : null}     
            ${modified === true ?
                html`<gcl-tool-tip>
                    <gcl-badge kind="primary" slot="trigger">
                        <span>M</span>
                    </gcl-badge>
                    <gcl-localized-text resource-key="thisFieldHasBeenModified" slot="content">This field has been modified</gcl-localized-text>
                </gcl-tool-tip>`
                : null}
            <slot name="tools"></slot>   
        </gcl-row>`;
    }
}
 
defineCustomElement('gcl-form-label', FormLabel);