trailheadapps/lwc-recipes

A collection of easy-to-digest code examples for Lightning Web Components on Salesforce Platform

Lightning Web Components Recipes

A collection of easy-to-digest code examples for Lightning Web Components. Each recipe demonstrates how to code a specific task in the fewest lines of code possible while following best practices. A "View Source" link takes you directly to the code on GitHub. From "Hello World" to data access and third-party libraries, there's a recipe for that!

Learn more about this app by completing the Quick Start: Explore the LWC Recipes Sample App Trailhead project or by watching this short presentation video.

This sample application is designed to run on Salesforce Platform. If you want to experience Lightning Web Components on any platform, please visit https://lwc.dev, and try out our Lightning Web Components sample application LWC Recipes OSS.

Table of contents

• Installing the app using a Scratch Org: This is the recommended installation option. Use this option if you are a developer who wants to experience the app and the code.

• Installing the app using an Unlocked Package: This option allows anybody to experience the sample app without installing a local development environment.

• Installing the app using a Developer Edition Org or a Trailhead Playground: Useful when tackling Trailhead Badges or if you want the app deployed to a more permanent environment than a Scratch org.

• Optional installation instructions

• Code tours

Installing the app using a Scratch Org

1. Set up your environment. Follow the steps in the Quick Start: Lightning Web Components Trailhead project. The steps include:

   • Enable Dev Hub in your Trailhead Playground
   • Install Salesforce CLI
   • Install Visual Studio Code
   • Install the Visual Studio Code Salesforce extensions, including the Lightning Web Components extension

2. If you haven't already done so, authorize your hub org and provide it with an alias (myhuborg in the command below):

   sf org login web -d -a myhuborg
   

3. Clone the lwc-recipes repository:

   git clone https://github.com/trailheadapps/lwc-recipes
   cd lwc-recipes
   

4. Create a scratch org and provide it with an alias (lwc-recipes in the command below):

   sf org create scratch -d -f config/project-scratch-def.json -a lwc-recipes
   

5. Push the app to your scratch org:

   sf project deploy start
   

6. Assign the recipes permission set to the default user:

   sf org assign permset -n recipes
   

7. Import sample data:

   sf data tree import -p ./data/data-plan.json
   

8. Open the scratch org:

   sf org open
   

9. In Setup, under Themes and Branding, activate the Recipes Lite or Recipes Blue theme.

10. In App Launcher, click View All then select the LWC app.

Installing the app using an Unlocked Package

Follow this set of instructions if you want to deploy the app to a more permanent environment than a Scratch org or if you don't want to install the local development tools. You can use non source-tracked orgs such as a free Developer Edition Org or a Trailhead Playground.

Make sure to start from a brand-new environment to avoid conflicts with any previous work you may have done.

1. Log in to your org

2. Click this link to install the Recipes unlocked package in your org.

3. Select Install for All Users

4. Import Account and Contacts data:

   • Click here to access the Accounts-Contacts.csv file. Right click on the browser window and save the file as Accounts-Contacts.csv.
   • In Setup, type Data Import in the Quick Find box and click Data Import Wizard.
   • Click Launch Wizard.
   • Click Accounts and Contacts, and click Add New Records.
   • Drag the Accounts-Contacts.csv file you just saved to the upload area.
   • Click Next, Next, and Start Import.

5. If you're attempting the Quick Start on Trailhead, this step is required, but otherwise, skip:

   • Go to Setup > Users > Permission Sets.
   • Click recipes.
   • Click Manage Assignments.
   • Check your user and click Add Assignments.

6. In Setup, under Themes and Branding, activate the Recipes Lite or Recipes Blue theme.

7. In App Launcher, click View All then select the LWC Recipes app.

Installing the App using a Developer Edition Org or a Trailhead Playground

Follow this set of instructions if you want to deploy the app to a more permanent environment than a Scratch org. This includes non source-tracked orgs such as a free Developer Edition Org or a Trailhead Playground.

Make sure to start from a brand-new environment to avoid conflicts with previous work you may have done.

1. Clone this repository:

   git clone https://github.com/trailheadapps/lwc-recipes
   cd lwc-recipes
   

2. Authorize your Trailhead Playground or Developer org and provide it with an alias (mydevorg in the command below):

   sf org login web -s -a mydevorg
   

3. Run this command in a terminal to deploy the app.

   sf project deploy start -d force-app
   

4. Assign the recipes permission set to the default user.

   sf org assign permset -n recipes
   

5. Import some sample data.

   sf data tree import -p ./data/data-plan.json
   

6. If your org isn't already open, open it now:

   sf org open -o mydevorg
   

7. In Setup, under Themes and Branding, activate the Recipes Lite or Recipes Blue theme.

8. In App Launcher, select the LWC app.

Optional Installation Instructions

This repository contains several files that are relevant if you want to integrate modern web development tools into your Salesforce development processes or into your continuous integration/continuous deployment processes.

Code formatting

Prettier is a code formatter used to ensure consistent formatting across your code base. To use Prettier with Visual Studio Code, install this extension from the Visual Studio Code Marketplace. The .prettierignore and .prettierrc files are provided as part of this repository to control the behavior of the Prettier formatter.

Warning The current Apex Prettier plugin version requires that you install Java 11 or above.

Code linting

ESLint is a popular JavaScript linting tool used to identify stylistic errors and erroneous constructs. To use ESLint with Visual Studio Code, install this extension from the Visual Studio Code Marketplace. The .eslintignore file is provided as part of this repository to exclude specific files from the linting process in the context of Lightning Web Components development.

Pre-commit hook

This repository also comes with a package.json file that makes it easy to set up a pre-commit hook that enforces code formatting and linting by running Prettier and ESLint every time you git commit changes.

To set up the formatting and linting pre-commit hook:

1. Install Node.js if you haven't already done so
2. Run npm install in your project's root folder to install the ESLint and Prettier modules (Note: Mac users should verify that Xcode command line tools are installed before running this command.)

Prettier and ESLint will now run automatically every time you commit changes. The commit will fail if linting errors are detected. You can also run the formatting and linting from the command line using the following commands (check out package.json for the full list):

npm run lint
npm run prettier

Code Tours

Code Tours are guided walkthroughs that will help you understand the app code better. To be able to run them, install the CodeTour VSCode extension.