Repository files navigation

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 theQuick Start: Explore the LWC Recipes Sample App Trailhead project or by watching thisshort presentation video.

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

• 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

1. Set up your environment. Follow the steps in theQuick 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-recipescd 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 therecipes 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. InSetup, underThemes and Branding, activate theRecipes Lite orRecipes Blue theme.

10. In App Launcher, clickView All then select theLWC app.

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 freeDeveloper Edition Org or aTrailhead 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. Clickthis link to install the Recipes unlocked package in your org.

3. SelectInstall for All Users

4. Import Account and Contacts data:

   • Clickhere to access theAccounts-Contacts.csv file. Right click on the browser window and save the file asAccounts-Contacts.csv.
   • InSetup, typeData Import in the Quick Find box and clickData Import Wizard.
   • ClickLaunch Wizard.
   • ClickAccounts and Contacts, and clickAdd New Records.
   • Drag theAccounts-Contacts.csv file you just saved to the upload area.
   • ClickNext,Next, andStart Import.

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

   • Go toSetup > Users > Permission Sets.
   • Clickrecipes.
   • ClickManage Assignments.
   • Check your user and clickAdd Assignments.

6. InSetup, underThemes and Branding, activate theRecipes Lite orRecipes Blue theme.

7. In App Launcher, clickView All then select theLWC Recipes app.

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 afree Developer Edition Org or aTrailhead 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-recipescd 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 therecipes 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. InSetup, underThemes and Branding, activate theRecipes Lite orRecipes Blue theme.

8. In App Launcher, select theLWC app.

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.

Prettier is a code formatter used to ensure consistent formatting across your code base. To use Prettier with Visual Studio Code, installthis 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.

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

ESLint is a popular JavaScript linting tool used to identify stylistic errors and erroneous constructs. To use ESLint with Visual Studio Code, installthis 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.

This repository also comes with apackage.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 yougit commit changes.

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

1. InstallNode.js if you haven't already done so
2. Runnpm 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 outpackage.json for the full list):

npm run lintnpm run prettier

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