Loading
Feature Disruption - Service Cloud VoiceRead More
Feature degradation | Gmail Email delivery failureRead More
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            Base Vlocity LWC ReadMe Reference (Managed Package)

            You are here:

            1. Salesforce Help
            2. Docs
            3. Omnistudio for Managed Packages

            Base Vlocity LWC ReadMe Reference (Managed Package)

            For the managed package runtime, view examples, and learn about available attributes, methods, and other functions from the ReadMes of each Base Vlocity Lightning web component.

            Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

            Downloadable ReadMes

            Released

            Download File

            November 2022

            baseLWCReadMes-November-2022.zip

            Spring '22

            baseLWCReadMes-Spring22.zip

            Winter '22

            baseLWCReadMes-Winter22.zip

            Spring '21

            baseLWCReadMes-Spring21.zip

            Links to ReadMes

            Component

            Description

            AccordionSection

            Adds the basic element inside the Accordion LWC.

            Accordion

            Displays content as vertically stacked sections.

            Action

            The base component for all action components.

            Alert

            Displays an SLDS or Newport styled alert.

            AsyncUtils

            A module that exposes a collection of utilities designed to simplify asynchronous operations

            BaseLayout

            All Vlocity cards extend this component.

            BaseState

            All Vlocity doc card layouts extend this component.

            Button

            Renders a button element to perform an action

            CarouselItem

            Displays the basic element inside a Carousel LWC.

            Carousel

            Displays a series of images inside a container one image at a time.

            ChartDonut

            Extends the Chart LWC and adds the ability to display and resize text at the center of the donut.

            Chart

            Displays data as a chart and enables users to perform actions from the chart.

            CheckboxGroup

            Enables users to select from single or multiple options.

            CheckboxImageGroup

            Extends the CheckboxGroup and enables users to select from single or multiple options by clicking images instead of checkboxes.

            Combobox

            Displays a read-only input element enabling users to select an option from a list of options.

            DataTableCell

            Adds the basic element inside a DataTable LWC to create individual cells.

            DataTable

            Creates a tabular structure of the data provided.

            DatasourceApexRemote

            Extends Datasource LWC with additional features for fetching data using an Apex class using a class and method.

            DatasourceApexRest

            Extends Datasource LWC with additional features for fetching data using an Apex class from a rest endpoint.

            DatasourceDataraptor

            Extends Datasource LWC with additional features for fetching data from an Omnistudio Data Mapper.

            DatasourceIntegrationprocedure

            Extends Datasource LWC with additional features for fetching data from an Integration Procedure.

            DatasourceQuery

            Extends Datasource LWC with additional features for fetching data using a Salesforce Object Query Language (SOQL) query.

            DatasourceRest

            Extends Datasource LWC with additional features for for data fetched from a REST web data source.

            DatasourceSdk

            Extends Datasource LWC with additional features for data fetched from an SDK.

            DatasourceSearch

            Extends Datasource LWC with additional features for etching data through a Salesforce Object Search Language (SOSL) query.

            Datasource

            Fetches data from Salesforce using different data source types by providing relevant input data.

            DatePicker

            Displays a date input element with a graphical user interface (GUI) widget that enables the user to select a date from a calendar.

            DateTimePicker

            Displays a set of input fields with graphical user interface (GUI) widgets that enables the user to select a date from a calendar and a time from a list.

            Form

            Creates a wrapper around Vlocity form elements to enable form capabilities.

            Icon

            Renders an SVG icon.

            Img

            Displays an available image.

            Input

            Renders an input element.

            InteractionWrapper

            A wrapper component for a customer interaction and the Power Launcher. The component is used inside a customer interaction records page to see all interactions with a customer and perform any actions related to the interaction.

            LayoutItem

            Adds the basic element inside the parent Layout LWC container, grouping content together to create sections inside the parent container.

            Layout

            Creates a flexible grid system arranging containers on a page or inside other containers.

            ListItems

            Adds the basic element for the List LWC. Creates the template for each list item.

            List

            Creates a searchable and sortable list from the data provided.

            MaskedInput

            Extends the Input LWC and controls what you can enter in the form input fields.

            MenuItem

            Adds the base element for building a menu with the Menu LWC.

            Menu

            Creates a menu from the list of menu items provided.

            Modal

            Displays content in a layer on top of the app, such as creating or editing a record, or various types of messaging and wizards.

            MonacoEditor

            Displays the code editor tool used inside Salesforce.

            NavigateAction

            Enables navigation to any of Salesforce PageReference type by leveraging Salesforce's navigation service.

            NavigationUtils

            A module that exposes a collection of utilities designed to simplify navigational functions.

            Newport Loader

            A utility that exposes a single load function used to ensure the Newport CSS styles load in the <head> of the page.

            OutputField

            Returns a read-only label, help text and value for the field name of a record.

            Pill

            Displays an input element that displays read-only labels, which can containing links and be removed from view on-demand.

            Popover

            Displays a non-modal dialog that must pair with a clickable trigger element and contain at least one focusable element.

            Power Launcher Action

            Displays Vlocity actions inside the PowerLauncher LWC and extends Action LWC.

            Power Launcher

            Gets and displays a list of vlocity actions based on the recordId.

            ProgressBar

            Displays progress of activity on a page.

            Prompt

            Displays simple content on a layer on top of an app. For example, use a prompt to confirm form submission or to direct the user to confirm a step in a process.

            Pubsub

            Enables data sharing between components. Multiple components can register and receive data from the same channel.

            RadioGroup

            Enables users to select from a list of options by selecting a radio button.

            RadioColorPickGroup

            Extends the RadioGroup LWC and enables users to choose from a list of options by selecting a color item instead of a radio button.

            RadioImageGroup

            Extends the RadioGroup LWC and enables users to choose from a list of options by selecting an image instead of a radio button.

            Related List

            Displays a table of data with a header that supports actions. All attributes from the DataTable LWC and SLDS Header LWC are available to this component.

            RichTextEditor

            Displays a text editor tool for rich content editing.

            SLDS Header

            Displays a page header, which contains a title, an icon, field data, and action links.

            Slider

            Displays a graphical control element for a user to set a value by moving an indicator horizontally or vertically.

            Spinner

            Displays an animated image that indicates a feature is loading

            Styles

            Specifies the theme of a component and gets the base CSS for that theme.

            Tabset

            Displays a tabbed container with multiple content areas, only one of which is visible at a time.

            Tab

            Adds the base element inside a Tabset LWC.

            Textarea

            Displays an HTML textarea element for entering multi-line text input that holds an unlimited number of characters.

            TimePicker

            Displays a graphical user interface (GUI) widget that allows the user to select a time from a list of options.

            Toast

            A feedback and confirmation tool that runs after the user takes an action.

            Toggle

            Enables a user to pick between two states, enable or disable an option, or select multiple options.

            Tooltip

            Displays an icon with a popover containing a small amount of text describing an element on the screen.

            TreeItem

            Adds the basic element in a Tree LWC.

            Tree

            Displays the visualization of a structural hierarchy, such as a sitemap for a website or a role hierarchy in an organization.

            TreeListSelector

            A variant of Tree Lightning Web Component that displays visualization of a structural hierarchy, that allows for browsing a tree based hierarchy as a list.

            TreeListSelectorItem

            Defines the individual items of a treeListSelector component.

            Typeahead

            Provides hints or a list of possible choices based on the text the user enters while filling out a form or performing a search.

            Utility Functions

            Helper functions available for all Vlocity Lightning Web Components.

            Wizard Item

            Creates the template for each wizard item inside the Wizard LWC.

            Wizard

            Displays a modal that enables navigating between steps in a process and displays a progress bar that shows where the user is in the process. Supports custom labels.
             
            Loading
            Salesforce Help | Article