Skip to content

forcedotcom/sf-skills / plugins/builder/experience-lwc/skills/experience-lwc-generate

experience-lwc-generate

Unverified

Lightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc/**/*.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use platform-apex-generate), Aura components, or Visualforce.

FileKindSize
README.mdmarkdown4.1 KB
SKILL.mdskill md9.6 KB
assets/apex-controller/LwcController.clsother12.0 KB
assets/basic-component/basicComponent.cssother1.5 KB
assets/basic-component/basicComponent.htmlother4.5 KB
assets/basic-component/basicComponent.jsscript7.3 KB
assets/basic-component/basicComponent.js-meta.xmlconfig4.5 KB
assets/datatable-component/datatableComponent.htmlother4.1 KB
assets/datatable-component/datatableComponent.jsscript13.1 KB
assets/flow-screen-component/flowScreenComponent.cssother1.7 KB
assets/flow-screen-component/flowScreenComponent.htmlother7.1 KB
assets/flow-screen-component/flowScreenComponent.jsscript13.9 KB
assets/flow-screen-component/flowScreenComponent.js-meta.xmlconfig3.9 KB
assets/form-component/formComponent.htmlother6.4 KB
assets/form-component/formComponent.jsscript11.3 KB
assets/graphql-component/graphqlComponent.htmlother4.8 KB
assets/graphql-component/graphqlComponent.jsscript10.7 KB
assets/jest-test/componentName.test.js.exampleother15.6 KB
assets/message-channel/RecordSelected.messageChannel-meta.xmlconfig2.4 KB
assets/message-channel/lmsPublisher.jsscript3.8 KB
assets/message-channel/lmsSubscriber.jsscript7.0 KB
assets/modal-component/modalComponent.htmlother3.2 KB
assets/modal-component/modalComponent.jsscript5.5 KB
assets/record-picker/recordPicker.htmlother2.0 KB
assets/record-picker/recordPicker.jsscript5.4 KB
assets/state-store/store.jsscript9.1 KB
assets/typescript-component/typescriptComponent.cssother1.3 KB
assets/typescript-component/typescriptComponent.htmlother4.3 KB
assets/typescript-component/typescriptComponent.js-meta.xmlconfig2.4 KB
assets/typescript-component/typescriptComponent.test.ts.exampleother13.6 KB
assets/typescript-component/typescriptComponent.tsscript11.7 KB
assets/workspace-api/workspaceComponent.htmlother3.4 KB
assets/workspace-api/workspaceComponent.jsscript8.0 KB
references/accessibility-guide.mdmarkdown22.3 KB
references/advanced-features.mdmarkdown2.8 KB
references/async-notification-patterns.mdmarkdown19.7 KB
references/cli-commands.mdmarkdown12.6 KB
references/component-patterns.mdmarkdown44.5 KB
references/flow-integration-guide.mdmarkdown19.0 KB
references/jest-testing.mdmarkdown25.3 KB
references/lms-guide.mdmarkdown21.9 KB
references/lwc-best-practices.mdmarkdown36.3 KB
references/performance-guide.mdmarkdown20.3 KB
references/scoring-and-testing.mdmarkdown3.8 KB
references/slds-blueprints.jsonconfig781.3 KB
references/slds-design-guide.mdmarkdown10.7 KB
references/state-management.mdmarkdown19.9 KB
references/template-anti-patterns.mdmarkdown20.1 KB
references/triangle-pattern.mdmarkdown12.5 KB
scripts/local-dev-preview.shscript1.1 KB
scripts/lwc-lsp-validate.pyscript8.6 KB
scripts/post-tool-validate.pyscript14.7 KB
scripts/slds_data/deprecated_patterns.jsonconfig3.4 KB
scripts/slds_data/styling_hooks.jsonconfig2.9 KB
scripts/slds_data/valid_slds_classes.jsonconfig7.4 KB
scripts/slds_linter_wrapper.pyscript8.9 KB
scripts/slds_rules/__init__.pyscript593 B
scripts/template_validator.pyscript13.5 KB
scripts/validate_slds.pyscript26.5 KB

assets/flow-screen-component/flowScreenComponent.js

View on GitHub
/**
 * Flow Screen Component Template
 *
 * Demonstrates complete Flow integration patterns:
 * - @api properties with inputOnly/outputOnly roles
 * - FlowAttributeChangeEvent for output binding
 * - FlowNavigationFinishEvent for programmatic navigation
 * - availableActions for navigation state awareness
 * - @AuraEnabled Apex integration for data operations
 *
 * @see https://developer.salesforce.com/docs/component-library/bundle/lightning-flow-support
 */
import { LightningElement, api, wire } from 'lwc';
import { FlowAttributeChangeEvent, FlowNavigationFinishEvent } from 'lightning/flowSupport';

// Apex imports (uncomment and modify as needed)
// import getRecords from '@salesforce/apex/FlowScreenController.getRecords';
// import processRecord from '@salesforce/apex/FlowScreenController.processRecord';

export default class FlowScreenComponent extends LightningElement {
    // ═══════════════════════════════════════════════════════════════════════
    // FLOW INPUT PROPERTIES (inputOnly - Flow → Component)
    // These receive values FROM the Flow. Changes in Flow update the component.
    // ═══════════════════════════════════════════════════════════════════════

    /**
     * Record ID from Flow context (e.g., from Record-Triggered Flow)
     * Maps to: Flow variable or $Record.Id
     */
    @api recordId;

    /**
     * Object API Name for context-aware behavior
     * Maps to: Flow variable or $Record.Object
     */
    @api objectApiName;

    /**
     * Custom label configurable in Flow Builder
     * Maps to: Flow constant, variable, or direct text
     */
    @api inputLabel = 'Select a Record';

    /**
     * Available navigation actions - automatically populated by Flow runtime
     * Possible values: ['NEXT', 'BACK', 'FINISH', 'PAUSE']
     * Use this to conditionally show/hide navigation buttons
     */
    @api availableActions = [];

    // ═══════════════════════════════════════════════════════════════════════
    // FLOW OUTPUT PROPERTIES (outputOnly - Component → Flow)
    // These send values BACK to the Flow. Use FlowAttributeChangeEvent to update.
    // ═══════════════════════════════════════════════════════════════════════

    /**
     * Selected record ID - output to Flow
     * IMPORTANT: Use FlowAttributeChangeEvent to notify Flow of changes
     */
    @api selectedRecordId;

    /**
     * Selected record name - output to Flow
     */
    @api selectedRecordName;

    /**
     * Boolean flag indicating completion - useful for Flow decisions
     */
    @api isComplete = false;

    /**
     * Error message if validation fails - Flow can use in fault path
     */
    @api errorMessage;

    // ═══════════════════════════════════════════════════════════════════════
    // PRIVATE REACTIVE PROPERTIES
    // ═══════════════════════════════════════════════════════════════════════

    records = [];
    error;
    isLoading = true;
    _selectedId;

    // ═══════════════════════════════════════════════════════════════════════
    // LIFECYCLE HOOKS
    // ═══════════════════════════════════════════════════════════════════════

    connectedCallback() {
        // Initialize component when added to DOM
        this.loadData();
    }

    // ═══════════════════════════════════════════════════════════════════════
    // DATA LOADING
    // ═══════════════════════════════════════════════════════════════════════

    /**
     * Load data - replace with @wire or imperative Apex call
     */
    async loadData() {
        this.isLoading = true;
        try {
            // Example: Load records from Apex
            // this.records = await getRecords({ parentId: this.recordId });

            // Placeholder data for template
            this.records = [
                { id: '001xx000000001', name: 'Sample Record 1', description: 'Description 1' },
                { id: '001xx000000002', name: 'Sample Record 2', description: 'Description 2' },
                { id: '001xx000000003', name: 'Sample Record 3', description: 'Description 3' }
            ];
            this.error = undefined;
        } catch (err) {
            this.error = this.reduceErrors(err);
            this.records = [];
        } finally {
            this.isLoading = false;
        }
    }

    // ═══════════════════════════════════════════════════════════════════════
    // FLOW OUTPUT - FlowAttributeChangeEvent
    // CRITICAL: This is how you send values back to Flow variables
    // ═══════════════════════════════════════════════════════════════════════

    /**
     * Handle record selection and notify Flow
     * @param {Event} event - Click event from record tile
     */
    handleRecordSelect(event) {
        const recordId = event.currentTarget.dataset.id;
        const recordName = event.currentTarget.dataset.name;

        // Update local state
        this._selectedId = recordId;
        this.selectedRecordId = recordId;
        this.selectedRecordName = recordName;

        // ─────────────────────────────────────────────────────────────────
        // CRITICAL: Dispatch FlowAttributeChangeEvent for EACH output
        // This notifies the Flow runtime that output values have changed
        // The first parameter is the @api property name (case-sensitive)
        // The second parameter is the new value
        // ─────────────────────────────────────────────────────────────────
        this.dispatchEvent(new FlowAttributeChangeEvent(
            'selectedRecordId',
            this.selectedRecordId
        ));

        this.dispatchEvent(new FlowAttributeChangeEvent(
            'selectedRecordName',
            this.selectedRecordName
        ));
    }

    /**
     * Update completion status and notify Flow
     * @param {Boolean} complete - Whether the screen is complete
     */
    setComplete(complete) {
        this.isComplete = complete;
        this.dispatchEvent(new FlowAttributeChangeEvent('isComplete', complete));
    }

    /**
     * Set error message and notify Flow
     * @param {String} message - Error message
     */
    setError(message) {
        this.errorMessage = message;
        this.dispatchEvent(new FlowAttributeChangeEvent('errorMessage', message));
    }

    // ═══════════════════════════════════════════════════════════════════════
    // FLOW NAVIGATION - FlowNavigationFinishEvent
    // Programmatically trigger Flow navigation (Next, Back, Finish, Pause)
    // ═══════════════════════════════════════════════════════════════════════

    /**
     * Navigate to next screen
     * Only works if 'NEXT' is in availableActions
     */
    handleNext() {
        // Validate before navigation
        if (!this.selectedRecordId) {
            this.setError('Please select a record before proceeding.');
            return;
        }

        // Clear any previous errors
        this.setError(null);

        // Mark as complete
        this.setComplete(true);

        // Check if NEXT action is available
        if (this.canGoNext) {
            // Dispatch navigation event - Flow will handle the rest
            this.dispatchEvent(new FlowNavigationFinishEvent('NEXT'));
        }
    }

    /**
     * Navigate to previous screen
     * Only works if 'BACK' is in availableActions
     */
    handleBack() {
        if (this.canGoBack) {
            this.dispatchEvent(new FlowNavigationFinishEvent('BACK'));
        }
    }

    /**
     * Finish the flow (for final screens)
     * Only works if 'FINISH' is in availableActions
     */
    handleFinish() {
        // Validate before finishing
        if (!this.selectedRecordId) {
            this.setError('Please select a record before finishing.');
            return;
        }

        this.setComplete(true);

        if (this.canFinish) {
            this.dispatchEvent(new FlowNavigationFinishEvent('FINISH'));
        }
    }

    /**
     * Pause the flow (for pausable flows)
     * Only works if 'PAUSE' is in availableActions
     */
    handlePause() {
        if (this.canPause) {
            this.dispatchEvent(new FlowNavigationFinishEvent('PAUSE'));
        }
    }

    // ═══════════════════════════════════════════════════════════════════════
    // APEX INTEGRATION (Optional)
    // Use @AuraEnabled methods for complex operations
    // ═══════════════════════════════════════════════════════════════════════

    /**
     * Example: Process selection with Apex before navigation
     */
    async handleProcessAndContinue() {
        this.isLoading = true;
        try {
            // Call Apex to process the selection
            // const result = await processRecord({
            //     recordId: this.selectedRecordId,
            //     operation: 'validate'
            // });

            // Simulate successful processing
            const result = { success: true, message: 'Validated successfully' };

            if (result.success) {
                this.setComplete(true);
                this.handleNext();
            } else {
                this.setError(result.message);
            }
        } catch (err) {
            this.setError(this.reduceErrors(err));
        } finally {
            this.isLoading = false;
        }
    }

    // ═══════════════════════════════════════════════════════════════════════
    // COMPUTED PROPERTIES
    // ═══════════════════════════════════════════════════════════════════════

    get hasRecords() {
        return this.records && this.records.length > 0;
    }

    get hasSelection() {
        return !!this._selectedId;
    }

    get canGoBack() {
        return this.availableActions.includes('BACK');
    }

    get canGoNext() {
        return this.availableActions.includes('NEXT');
    }

    get canFinish() {
        return this.availableActions.includes('FINISH');
    }

    get canPause() {
        return this.availableActions.includes('PAUSE');
    }

    get showBackButton() {
        return this.canGoBack;
    }

    get showNextButton() {
        return this.canGoNext;
    }

    get showFinishButton() {
        return this.canFinish && !this.canGoNext;
    }

    /**
     * Compute selected class for record tiles
     */
    getRecordClass(recordId) {
        return this._selectedId === recordId
            ? 'slds-box slds-box_link slds-theme_shade slds-is-selected'
            : 'slds-box slds-box_link';
    }

    // ═══════════════════════════════════════════════════════════════════════
    // UTILITIES
    // ═══════════════════════════════════════════════════════════════════════

    /**
     * Reduce various error formats to a string
     * @param {*} errors - Error object(s)
     * @returns {String} - Formatted error message
     */
    reduceErrors(errors) {
        if (!Array.isArray(errors)) {
            errors = [errors];
        }

        return errors
            .filter(error => !!error)
            .map(error => {
                if (error.body?.message) return error.body.message;
                if (error.message) return error.message;
                return JSON.stringify(error);
            })
            .join('; ');
    }
}
finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the workStars: 322kUpdated Claude CodeCodexVerifiedInstall
systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesStars: 322kUpdated Claude CodeCodexVerifiedInstall
test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation codeStars: 322kUpdated Claude CodeCodexVerifiedInstall
skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.Stars: 198kUpdated Claude CodeCodexVerifiedInstall