Skip to content

Commit

Permalink
fix: messages for generate tab
Browse files Browse the repository at this point in the history
jshackell-sfdc authored Jul 29, 2022

Verified

This commit was signed with the committer’s verified signature.
svc-excavator-bot Excavator Bot
1 parent 635a091 commit ae9d0ef
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions messages/generate.tab.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,38 @@
# summary

Generate a tab for a custom object.
Generate the metadata source files for a new custom tab on a custom object.

# description

Description of a command.
Custom tabs let you display custom object data or other web content in Salesforce. Custom tabs appear in Salesforce as an item in the app’s navigation bar and in the App Launcher.

This command must be run in a Salesforce DX project directory. You must pass all required information to it with the required flags. The source files for the custom object for which you're generating a tab don't need to exist in your local project.

# flags.object.summary

API name of the object to generate a tab for.
API name of the custom object you're generating a tab for.

# flags.object.description

API name of the object to generate a tab for. Custom objects should end in \_\_c. The object need not be present in your local source.
The API name for a custom object always ends in "__c", such as "MyObject__c".

# flags.directory.summary

Path to a `tabs` folder that your new tab will be created in.
Path to a "tabs" directory that will contain the source files for your new tab.

# flags.icon.summary

An icon number from <https://lightningdesignsystem.com/icons/#custom> from 1 to 100'
Number from 1 to 100 that specifies the color scheme and icon for the custom tab.

# flags.icon.description

See https://lightningdesignsystem.com/icons/\#custom for the available icons.

# examples

- <%= config.bin %> <%= command.id %> -o MyObj\_\_c -i 54 -d force-app/main/default/tabs
- Create a tab on the MyObject__c custom object:

<%= config.bin %> <%= command.id %> --object MyObject__c --icon 54 --directory force-app/main/default/tabs

# success

0 comments on commit ae9d0ef

Please sign in to comment.