Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/forcedotcom/lwc-dev-mobile
https://github.com/forcedotcom/lwc-dev-mobile
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/forcedotcom/lwc-dev-mobile
- Owner: forcedotcom
- License: mit
- Created: 2020-03-23T21:59:32.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T17:44:42.000Z (about 2 months ago)
- Last Synced: 2024-11-04T18:35:10.668Z (about 2 months ago)
- Language: TypeScript
- Size: 2.66 MB
- Stars: 25
- Watchers: 14
- Forks: 11
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-sfdx-plugins - lwc-dev-mobile
README
[](https://codecov.io/gh/forcedotcom/lwc-dev-mobile)
[](http://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/@salesforce/lwc-dev-mobile?activeTab=versions)
[](https://www.npmjs.com/package/@salesforce/lwc-dev-mobile?activeTab=versions)
[](https://www.npmjs.com/package/@salesforce/lwc-dev-mobile?activeTab=versions)
# Salesforce CLI Mobile Extensions
The Salesforce CLI Mobile Extensions allow you to extend the local preview capabilities of the [Local Development Server plug-in](https://developer.salesforce.com/tools/vscode/en/localdev/lwclocaldev). You can see live previews of your Lightning Web Components on virtual mobile devices for iOS and Android.
**Note:** This feature is in beta, and may contain significant problems, undergo major changes, or be discontinued. If you encounter any problems, or want to request an enhancement, please open a [GitHub Issue](https://github.com/forcedotcom/lwc-dev-mobile/issues).
# Setup
## System Requirements
- Developer Hub-enabled org
- Most recent stable version of Chrome, Firefox, Safari, or Edge web browser
- Supported Windows versions: Windows 10 or later
- Supported Mac versions: macOS 10.14.4 or later
- Salesforce CLI
To develop Lightning web components, use your favorite code editor. We recommend using Visual Studio Code because its [Salesforce Extensions for VS Code](https://developer.salesforce.com/tools/extension_vscode) provide powerful features for development on Lightning Platform.
## Installation
1. Open a new terminal window and run the following command to install the Mobile Extensions:
sfdx plugins:install @salesforce/lwc-dev-mobile
2. Check for updates to the plug-in:
sfdx plugins:update
## Running
### Prerequisites
The Mobile Extensions plug-in can run only in the context of an SFDX project. See the [installation instructions](https://www.npmjs.com/package/@salesforce/lwc-dev-server#installation) of the Local Development plug-in for all SFDX project setup requirements.
### Usage
The Mobile Extensions plug-in supports two commands.
#### Setup
Setup helps you set up virtual mobile devices—iOS simulators and Android emulators—in your local environment.
```
sfdx force:lightning:local:setup -p
```
- `-p, --platform=platform` Specify platform (iOS or Android)
For example:
```sh-session
$ sfdx force:lightning:local:setup -p iOS
```
#### Preview
Preview extends the local preview capabilities of the [Local Development Server plug-in](https://developer.salesforce.com/tools/vscode/en/localdev/lwclocaldev). With Mobile Extensions, you can use this plug-in to preview your Lightning Web Components on virtual mobile devices.
```
sfdx force:lightning:lwc:preview -n -p ] [-t ]
```
- `-n, --componentname=componentname` The LWC component name
- `-p, --platform=platform` Specify platform (iOS or Android)
- `-t, --target=target` Specify name of target simulator or emulator
For example:
```sh-session
$ sfdx force:lightning:lwc:preview -p Android -t LWCEmulator -n HelloWorldLwcComponent
```
## Visual Studio Code
We also provide a Visual Studio Code extension that exposes the Preview functionality through the IDE. That functionality is currently developed as part of the [Salesforce Extensions for VS Code](https://github.com/forcedotcom/salesforcedx-vscode).
## Plugin Development
If you intend to develop or test drive the plug-in locally, this section will help you set up your development environment.
### Checkout and Build Locally
After you clone or fork this repo, run the following commands in the root folder of your local repo:
```sh-session
$ yarn install && yarn build
$ yarn test
```
### Install the Plug-in
From the top-level folder of the plug-in:
```sh-session
$ sfdx plugins:link .
```
### Uninstall the Plug-in
From the top-level folder of the plug-in:
```sh-session
$ sfdx plugins:uninstall .
```