Lightning Web Runtime, outside of the context of Experience Cloud, has been featured on the Create User Experiences with Lightning Web Components episode at Dreamforce. What is this pilot about?
Lightning Web Runtime (LWR) – outside of the context of Experience Cloud
lightning-web-componentslightning-web-runtimewinter22
Related Solutions
Lightning web components (LWC) are a new programming model for the Lightning Component Framework that is slated to be released in the Spring 19 release. This programming model was architected with three principles in mind.
- Align with modern web standards
- Interoperability with the original Aura-based Lightning component development model
- Performance
Standards
LWC is compliant with most ES2015 (aka ES6) and later standards that have seen good adoption across modern browsers. JavaScript APIs such as Class
, Module
, Shadow DOM, CustomComponent
, decorators, mix-ins, and many more figure heavily into the architecture, as do modern HTML and CSS features. This brings a great deal of benefit for the developer. First, the main body of knowledge and skill required is modern JavaScript. It also brings a much simplified component bundle structure and developer experience where a given component is comprised solely of an HTML template, a JavaScript module, and a CSS file (where required).
Here's a screen shot of the component bundle (no CSS) in a project in VisualStudio Code.
Here's an example of the code from a Lightning web component:
HTML Template:
<template>
<lightning-card title="RecordEditFormDynamicContact" icon-name="standard:contact">
<div class="slds-m-around_medium">
<lightning-record-edit-form
object-api-name="objectApiName"
record-id="recordId">
<lightning-messages></lightning-messages>
<lightning-input-field field-name="Name"></lightning-input-field>
<lightning-input-field field-name="Title"></lightning-input-field>
<lightning-input-field field-name="Phone"></lightning-input-field>
<lightning-input-field field-name="Email"></lightning-input-field>
<div class="slds-m-top_medium">
<lightning-button variant="brand" type="submit" name="save" label="Save"></lightning-button>
</div>
</lightning-record-edit-form>
</div>
</lightning-card>
</template>
JS Module:
import { LightningElement, api } from 'lwc';
export default class RecordEditFormDynamicContact extends LightningElement {
@api recordId;
@api objectApiName;
}
While this is a very simple component that simply surfaces two attributes (the @api
decorated properties), you can already see how the JS code reflects modern standards in the import
statement for including other JS modules, the export
of the class of this module, the use of the class
and extends
syntax, and the use of JavaScript decorators.
Interoperability
In designing a new programming model for the Lightning Component framework, interoperability with existing Aura-based components is a must. With the GA of LWC, any component built using the LWC programming model can be used in an existing Lightning Component page. To prove this model, Salesforce have used LWC to build Lightning base components for the last year. Any of your existing Lightning Web Components that use a lightning:xxx
base component is already using LWC.
Performance
Salesforce has yet to publish any benchmarks or performance data related to Lightning Web Components. But look for upcoming blog posts from the LWC engineering team.
Anecdotally, as more and more of the Lightning Experience UI has become composed of LWC over the past year, many customers have reflected back to Salesforce an experience of better performance.
Learn More
For more details about LWC, please see the introductory blog post on the Salesforce developer blog which has many links to documentation, sample code and applications, and of course, Trailhead.
Aagh! I don't want to read a whole blog, I just want to do something!
No problem. Just go to this quick start project on Trailhead and get the badge.
The core issue here is that the:
<lightning-input-field></lightning-input-field>
expects to have data via a
<lightning-record-edit-form></lighting-record-edit-form>
Since the playground is not backed by a Salesforce Org there is inherently no Record data.
The documentation says:
To create a record create layout, use this component with lightning-record-edit-form and pass in the object API name of the record you're creating. You don't need additional Apex controllers or Lightning Data Service as data refresh happens automatically.
While docs don't explicitly call out that you can't use this on it's own this is the case.
You can use a
<lightning-input></lightning-input>
There are some pre-made examples in the playground.
Best Answer
LWR is a way to configure and load the modules, services, and dependency providers you need to build a JavaScript app. You can deploy on a variety of runtime environments, depending on your use case. For example, LWR works in a local Node.js runtime, or as a standalone instance in Heroku.
You can start by building a simple static website in your local environment. Simply run
npm init lwr
and follow the wizard steps to scaffold a LWC static site or a single page application.