Content

Add

Takes an existing object and uses it in a new context (for example, adds an item to the cart, adds a user to a group, or adds a document to a folder).

Where appropriate, combine add with the object (for example, Add user or Add role). Compare Create, Insert, New, and Upload. See also the Add pattern.

Apply

Saves changes without closing the dialog. These properties often affect subsequent system behavior.

Use instead of Save changes. Compare Save and Save as.

Approve

Indicates the user agrees. In a business process, typically initiates the next step.

Compare Reject.

Back

Returns the user to the previous step in a sequence of steps, such as in a wizard.

Use instead of Previous. Compare Next and Finish.

Browse

Assists the user in selecting a file (for example, on a button or link next to an entry field). Typically opens a secondary window where the user can locate and select the desired directory and file.

Cancel

Stops the current action and closes the dialog.

Warn the user of any possible negative consequences of stopping an action from progressing, such as data corruption. Compare Reset. See also the Cancel pattern.

Clear

This action clears all the fields or selections. Also deletes the contents of a document, such as a log. Typically the default selection or value is re-established for controls that always have a selection or value, such as radio buttons.

Where appropriate, combine clear with the object (for example, Clear fields or Clear all). Compare Delete and Remove. See also the Clear pattern.

Close

Closes the current page or window (for example, closing a secondary window containing online help).

Do not use Close alongside OK or Cancel actions. Compare Cancel and Done. See also the Close pattern.

Copy

Creates new instances of the selected objects in a specific destination.

Combine Copy with the object being copied (for example, Copy folder) or the destination (for example, Copy to clipboard) if there are multiple possibilities. Compare New. See also the Copy pattern.

Create

Makes a new object from scratch (for example, creates a calendar event or creates a new document).

In scenarios where the user needs to supply some details or settings as part of the create process, use new to initiate the action and create to apply the user-supplied details or settings to the new object. Compare Add, Copy, Insert, and New.

Customize

Allow a user to make desired changes.

Delete

Destroys an existing object so that it no longer exists (for example, deletes a file from a directory or deletes a value from a table cell).

Where appropriate, combine Delete with the object (for example, Delete column or Delete row). Compare Clear and Remove. See also the Delete pattern

Docs

Opens a separate window containing the landing page for the product documentation.

Use as link text only for the specific link that points to the product documentation from the console menu bar. Compare Learn more.

Done

Indicates that the user has finished working in an environment (for example, editing templates) and wants to return to where he or she came from.

Compare Close and Finish.

Download

Transfers a file from a remote system to a local system.

Compare Upload.

Drop

Use only when referring to dropping a database table.

In other scenarios, use Clear, Delete, or Remove.

Edit

Allows data or values to be changed.

See also the Edit pattern.

Empty trash

Permanently deletes all files or objects that have been placed into a trash container.

Compare Move to trash.

Export

Saves data in a different format external to the system. Typically opens a secondary window for the user to specify the file type and destination (for example, storing table data as a set of comma-separated values).

Compare Import.

Filter

Shortens a list to objects that match the filter criteria.

Compare Find and Search.

Find

Moves the cursor to the next element matching the specified criteria (for example, view the next occurrence of a specific word within an email message).

Compare Filter and Search.

Finish

Indicates completion of a series of steps, such as in a wizard.

Compare Done.

Get help

Opens a search field from which the user can search for help information.

Use only as link text on the console menu bar. Compare Docs and Learn more.

Hide

Removes an element that was previously shown (for example, enables the user to hide details or descriptions).

Compare Show.

Import

Transforms data or objects from an external source. Typically opens a secondary window for the user to locate the external source.

Context: Creating a new table based on comma-separated values contained in a separate file. Compare Export.

Insert

Adds an element at a particular position in an ordered view.

Context: Adding a picture to the body of a document or inserting a record into a table. Compare Add and New.

Launch

Do not use Launch; use Start.

Learn more

Opens additional, highly contextual information. Insert at the end of inline text or hover text where more information follows but does not fit in the current context.

If space permits, combine Learn more with meaningful text that describes the content you're pointing to. For example, if your user needs some best practices to manage apps in multiple regions, you could use Learn more about regions.

Log in

Enters a site or application. This choice typically opens a form for entry of credentials. Also used on the submission button after users enter their credentials.

Use instead of Sign in. This is to make it visually distinct from Sign up. These options are often side by side and the different words allow for quick recognition. Compare Log out. See also the Login pattern.

Log out

Exits an application or site.

Use instead of Sign out. Compare Log in. See also the Login pattern.

Move

Transfers an object from one container (for example, folder, activity, or page) to another.

Move to trash

A soft delete. Moves a file or object to an area from where it can later be permanently deleted or recovered.

Use instead of Delete if it is possible for the user to recover the objects. Compare Empty trash.

New

Starts the creation of a new object. New either creates the object immediately or opens a dialog or set of fields where the user can enter properties.

Combine new with the object to create (for example, New user or New column). Compare Add, Copy, Create, Insert, and Save as.

Next

Advances the user to the next step in a sequence of steps, such as in a wizard.

Compare Back and Finish. See also the Next pattern.

OK

Confirms an action or completes the current task.

Best practice is to use a label corresponding to the specific action (for example, Save or Close or Delete). Use OK only when such a label is not available. Write as shown: two letters, both uppercase.

Play

Starts audio, video, or an animation.

Post

Adds a new comment to an online community or adds status to a log or record.

If you are editing an existing comment, use Save instead.

Preview

Shows how an object or content will appear with formatting applied before the content is published or distributed. Alternatively, provides an incomplete display of an existing object without leaving the current context.

Print

Sends a copy of the currently selected object or the object in view to the printer.

Redo

Redoes an undo action.

Likely used only as a tooltip on an icon button. Compare Undo.

Refresh

Reloads the view of an object when the displayed view has become unsynchronized with the source.

Likely used only as a tooltip on an icon button. See also the Refresh pattern.

Reject

Indicates the user does not approve. In a business process, typically blocks the process from proceeding to the next step.

Compare Approve.

Remove

Removes an object from the current context but the object is not destroyed as a result of the action (for example, removes a user from a group or removes an item from the cart).

Where appropriate, combine Remove with the object that will be removed (for example, Remove user or Remove role). Compare Clear and Delete. See also the Remove pattern.

Reply

Indicates or completes a response to an email or a comment.

Reset

Reverts values back to their last saved state. The last saved state includes the values stored the last time the user clicked Apply. Does not close the dialog or window.

Compare Cancel, Restore, Restore defaults, and Undo. See also the Reset pattern.

Restore

Brings a file back after deletion, corruption, or similar event.

Compare Reset.

Restore all

Completes a restore operation on all files or objects in a given system or container.

Compare Restore.

Restore defaults

Sets form values to the default settings.

Compare Reset and Undo.

Run

Initiates a procedure.

Use Run instead of Execute.

Save

Saves pending modifications made to a file or document. Does not close the window or panel.

Compare Apply.

Save as

Creates a new object based on the state of the object currently being viewed. The user names the new object and typically identifies its location.

Search

Returns all objects (for example, files, names, or documents) within a defined set (for example, in a folder, directory, database, or the internet) that match some specified criteria.

Compare Filter and Find.

Select

Selects data from a table.

Select all

Adds all objects in the view to the selection set or checks all checkboxes.

Compare Clear.

Send

Transfers an email or other information to the recipient or destination.

Show

Reveals an object that was previously hidden (for example, shows descriptions or shows further details).

Compare Hide.

Sign up

Creates a user account or registers a user in a system.

Use instead of Register.

Sort

Sorts a list or table column.

Likely used only as a tooltip on an icon button. Can be used without 'ascending' or 'descending' only if the order can be provided to a screen reader in the code for accessibility.

Start

Deploy an app or service to its development or production environment so that it can be used.

Use instead of Launch.

Submit an idea

Opens a separate window containing the IBM Cloud Ideas portal.

Use only as link text on the Support widget from the console menu bar.

Top

Returns to the top of the page.

Use instead of Back to top.

Undo

Reverts to the state before the most recent changes made by the user. Repeated use successively reverts to prior states in reverse chronological order. Applies to changes in data and not to changes made to the view.

Not all actions, such as Save, can be undone. Compare Redo, Reset, and Restore.

Update

Label for a button in a dialog or form for editing an object. The settings in the dialog are applied to the object when it is updated.

Compare Edit.

Upload

Transfers a file from a local system to a remote system.

Compare Download.

View details

Presents additional information or properties for the object.