Skip to main content

Command Bar (Quick Actions) User Guide

Updated over 5 months ago

Welcome to the Command Bar of RentalTide! This guide will help you navigate and utilize the Command Bar effectively, enhancing your productivity by providing quick access to various actions and navigation within your organization's Point of Sale (POS) system.

Introduction

The Command Bar is a powerful feature designed to streamline your workflow by allowing quick access to frequently used actions and navigational routes within RentalTide's POS system. By leveraging keyboard shortcuts and an intuitive interface, the Command Bar enhances efficiency and user experience.

Key Features:

  • Keyboard Shortcut Access: Open the Command Bar effortlessly using ⌘K (Mac) or Ctrl+K (Windows/Linux).

  • Quick Actions: Execute common tasks such as adding stores, managing users, and accessing settings without navigating through multiple menus.

  • Seamless Navigation: Jump to different sections of the application instantly.

  • Customization: Personalize your workflow by utilizing various commands tailored to your needs.

  • Engaging Shortcuts: Enjoy fun and practical shortcuts like toggling between light and dark modes or even getting Rickrolled!

Dashboard Overview

Upon integrating the Command Bar into your workflow, you'll encounter the following key components:

  • Trigger Button:

    • Label: "Quick actions"

    • Icon: TbSearch (Search Icon)

    • Shortcut Indicator: Displays the keyboard shortcut ⌘K

    • Functionality: Clicking this button opens the Command Bar dialog.

  • Command Bar Dialog:

    • Input Field: Allows you to type commands or search for actions.

    • Command List: Displays a list of actionable items categorized for easy access.

    • Icons: Visual icons representing each command for quick identification.

    • Shortcuts: Displayed alongside commands to indicate additional keyboard shortcuts.

  • Animations:

    • Framer Motion Integration: Smooth transitions when opening and closing the Command Bar for a polished user experience.

Using the Command Bar

The Command Bar is designed to be intuitive and user-friendly. Here's how to make the most of its features:

1. Opening the Command Bar

Keyboard Shortcut:

  • Mac: Press ⌘K

  • Windows/Linux: Press Ctrl+K

Via Mouse:

  • Click on the "Quick actions" button located prominently within the interface.

Steps:

  1. Trigger the Command Bar: Use the keyboard shortcut or click the button to open the Command Bar dialog.

  2. Autofocus Input: The input field will automatically focus, ready for your command or search query.

2. Navigating Commands

Once the Command Bar is open, you can execute commands or navigate through the application efficiently.

Command List:

  • Invite more teammates

    • Icon: TbUserPlus

    • Shortcut: I, T

    • Navigation: /manage-users

  • Go to Home

    • Icon: TbHome

    • Shortcut: G, H

    • Navigation: /home

  • Go to Bookings

    • Icon: TbPropeller

    • Shortcut: G, B

    • Navigation: /bookings

  • Go to Calendar

    • Icon: TbCalendar

    • Shortcut: G, C

    • Navigation: /calendar

  • Go to Matrix

    • Icon: TbAd2

    • Shortcut: G, M

    • Navigation: /matrix

  • Go to Customers

    • Icon: TbIdBadge

    • Shortcut: G, C

    • Navigation: /customers

  • Go to Weather

    • Icon: TbCloudDown

    • Shortcut: G, W

    • Navigation: /weather

  • Go to Inventory

    • Icon: TbSpeedboat

    • Shortcut: G, I

    • Navigation: /inventory

  • Go to Maintenance

    • Icon: TbTool

    • Shortcut: G, M

    • Navigation: /maintenance

  • Go to Carbon Footprint

    • Icon: TbCloud

    • Shortcut: G, M

    • Navigation: /carbonFootprint

  • Go to Capital

    • Icon: TbMoneybag

    • Shortcut: G, C

    • Navigation: /capital

  • Go to Promo Codes

    • Icon: TbTag

    • Shortcut: G, P

    • Navigation: /promo-codes

  • Refresh cache

    • Icon: TbRefresh

    • Shortcut: R, C

    • Action: Clears the browser's local storage.

  • Copy current link to clipboard

    • Icon: TbLink

    • Shortcut: C, L

    • Action: Copies the current page URL to the clipboard.

  • Change to Light Mode

    • Icon: TbSun

    • Shortcut: L, M

    • Action: Switches the application theme to light mode.

  • Change to Dark Mode

    • Icon: TbMoon

    • Shortcut: D, M

    • Action: Switches the application theme to dark mode.

  • Get Rickrolled

    • Icon: TbBrandYoutube

    • Action: Redirects to the classic Rick Astley music video on YouTube.

Executing Commands:

  1. Type to Search: Begin typing the command or action you wish to perform. The Command Bar will filter results based on your input.

  2. Select a Command: Navigate through the list using arrow keys or by clicking on the desired command.

  3. Execute: Press Enter or click to execute the command.

3. Managing Shortcuts

Each command may have associated keyboard shortcuts that allow you to perform actions even more swiftly.

Examples:

  • Invite more teammates: Press I followed by T.

  • Go to Home: Press G followed by H.

  • Change to Dark Mode: Press D followed by M.

Usage Tips:

  • Sequential Keys: Some shortcuts require pressing keys in sequence (e.g., G then H for Home).

  • Memorize Frequent Shortcuts: Familiarize yourself with the shortcuts for actions you perform regularly to enhance efficiency.

4. Special Commands

Beyond navigation and standard actions, the Command Bar includes unique commands for specific functionalities.

Examples:

  • Refresh cache:

    • Action: Clears the browser's local storage to refresh cached data.

    • Usage: Useful when experiencing issues that may be resolved by clearing cached data.

  • Copy current link to clipboard:

    • Action: Copies the current page URL to your clipboard.

    • Usage: Convenient for sharing links quickly without manual copying.

  • Change Theme Modes:

    • Actions: Toggle between light and dark modes to suit your visual preference or environment.

  • Get Rickrolled:

    • Action: Redirects to Rick Astley's "Never Gonna Give You Up" music video.

    • Usage: A fun Easter egg within the application.

Permissions and Access Control

Access to the Command Bar and its functionalities is governed by a robust permissions system to ensure that only authorized users can execute specific actions.

Key Permissions:

  • command_access: Grants access to the Command Bar and its basic functionalities.

  • stores_add: Allows users to add new store locations.

  • stores_edit: Permits users to edit existing store locations.

  • stores_delete: Enables users to delete store locations.

  • stores_view_settings: Allows users to view and manage store-specific settings.

  • stores_view_stripe_connect: Grants access to manage Stripe Connect integrations for stores.

  • subscription_edit: Allows users to change subscription plans.

  • users_access: Grants access to the Users Page and its functionalities.

  • users_add: Allows users to add new user accounts.

  • users_edit: Permits users to edit existing user accounts.

  • users_delete: Enables users to delete user accounts.

  • profile_access: Grants access to the Profile Page and its functionalities.

  • profile_edit: Allows users to update personal information and notification settings.

  • profile_delete: Enables users to delete their accounts.

Managing Permissions:

  • Role-Based Access: Permissions are typically assigned based on user roles within the organization (e.g., Admin, Manager, Staff).

  • Verification: The Command Bar checks user permissions before rendering action buttons or enabling functionalities to prevent unauthorized access.

Usage Tips:

  • Ensure Proper Access: Verify that your user account has the necessary permissions to perform desired actions via the Command Bar.

  • Requesting Access: If you lack certain permissions but require them for your role, contact your system administrator or support team to request access.

  • Regular Audits: Periodically review and update user permissions to align with organizational changes and role evolutions.

Error Handling and Notifications

The Command Bar incorporates robust error handling and user-friendly notifications to keep you informed about the system's status and any issues that may arise.

Key Features:

  • Snackbar Notifications:

    • Success Messages: Confirm successful execution of commands (e.g., "Profile updated successfully").

    • Error Messages: Inform users of any failures during command execution (e.g., "Failed to upload image").

  • Loading Indicators:

    • CircularProgress: Indicates ongoing operations like data fetching or processing actions within commands.

  • Validation Feedback:

    • Ensure that inputs (like URLs or form fields) are correctly formatted before executing related commands.

Usage Tips:

  • Immediate Feedback: Pay attention to snackbar notifications for instant updates on your actions and system status.

  • Handle Errors Promptly: Address any error messages or alerts immediately to ensure smooth operations and accurate command executions.

  • Maintain Connectivity: Ensure a stable internet connection to facilitate seamless command executions and data fetching.

Frequently Asked Questions (FAQs)

1. How do I open the Command Bar using the keyboard shortcut?

  • Answer:

    • Mac: Press ⌘K.

    • Windows/Linux: Press Ctrl+K.

    • Alternative: Click on the "Quick actions" button to open the Command Bar.

2. Why is the Command Bar not opening when I press ⌘K or Ctrl+K?

  • Answer:

    • Possible Causes:

      • The Command Bar is disabled for your user account.

      • Another application or browser extension is intercepting the keyboard shortcut.

      • JavaScript errors preventing the Command Bar from functioning correctly.

    • Solutions:

      1. Check Permissions: Ensure your account has the command_access permission.

      2. Disable Conflicting Extensions: Temporarily disable browser extensions that might be intercepting the shortcut.

      3. Refresh the Page: Reload the application to resolve potential JavaScript errors.

      4. Contact Support: If the issue persists, reach out to RentalTide support for assistance.

3. How can I customize the commands available in the Command Bar?

  • Answer:

    • Customization by Developers: The Command Bar's commands are defined in the application's codebase. To add or modify commands, you need access to the source code.

    • User-Level Customization: Currently, end-users cannot customize the Command Bar. Feature requests for user-level customization can be submitted to RentalTide support for consideration.

4. Can I assign my own keyboard shortcuts to specific commands?

  • Answer:

    • Default Shortcuts: Each command comes with predefined shortcuts for quick access.

    • Customization: Customizing keyboard shortcuts is not supported at the user level. However, developers can modify or add shortcuts within the application's codebase.

    • Feature Requests: If customizable shortcuts are essential for your workflow, consider submitting a feature request to RentalTide support.

5. What should I do if executing a command doesn't perform the expected action?

  • Answer:

    • Possible Causes:

      • Insufficient permissions to perform the action.

      • The command is not correctly implemented or has bugs.

      • Network issues preventing the action from completing.

    • Solutions:

      1. Check Permissions: Ensure your account has the necessary permissions for the action.

      2. Retry the Command: Attempt to execute the command again to rule out temporary issues.

      3. Inspect Console for Errors: Open your browser’s developer console to check for any JavaScript errors.

      4. Refresh the Page: Reload the application to resolve potential glitches.

      5. Contact Support: If the issue persists, reach out to RentalTide support with specific details about the problem.

6. Is the Command Bar available on all pages of the application?

  • Answer:

    • Availability: The Command Bar is integrated into the application's main layout and is accessible from all primary pages, providing consistent access to commands and navigation across the platform.

    • Access Control: Access to the Command Bar and specific commands within it may vary based on user permissions.

7. Can I execute multiple commands in succession using the Command Bar?

  • Answer:

    • Sequential Execution: You can execute commands one after the other by reopening the Command Bar after each action.

    • Batch Commands: Executing multiple commands simultaneously is not supported. Each command is intended to perform a single action to maintain clarity and prevent unintended operations.

Troubleshooting

Issue 1: Command Bar Not Opening with Keyboard Shortcut

  • Possible Cause: The keyboard shortcut is being intercepted by another application or browser extension, or the Command Bar is disabled for your account.

  • Solution:

    1. Check Permissions: Ensure your account has the command_access permission.

    2. Disable Conflicting Extensions: Temporarily disable browser extensions that might be intercepting the shortcut.

    3. Try Alternative Shortcuts: Use Ctrl+K on Windows/Linux if ⌘K isn't working on Mac, and vice versa.

    4. Refresh the Page: Reload the application to resolve potential JavaScript errors.

    5. Contact Support: If the issue persists, reach out to RentalTide support for assistance.

Issue 2: Commands Not Executing Properly

  • Possible Cause: Insufficient permissions, JavaScript errors, or network issues.

  • Solution:

    1. Verify Permissions: Ensure your user account has the necessary permissions for the intended action.

    2. Check Network Connection: Ensure you have a stable internet connection.

    3. Inspect Console for Errors: Open your browser’s developer console to identify any JavaScript or network errors.

    4. Retry the Command: Attempt to execute the command again after addressing any identified issues.

    5. Contact Support: If the problem continues, reach out to RentalTide support with specific error details for assistance.

Issue 3: Commands with Shortcuts Not Responding

  • Possible Cause: Incorrect implementation of shortcuts, conflicts with other shortcuts, or Command Bar not recognizing the input.

  • Solution:

    1. Ensure Correct Shortcut Sequence: Follow the exact sequence of keys as defined (e.g., press G followed by H for Home).

    2. Check for Conflicts: Other applications or browser extensions might be using the same shortcuts. Disable or reconfigure them if necessary.

    3. Refresh the Page: Reload the application to reset the Command Bar state.

    4. Inspect Console for Errors: Look for any errors that might prevent shortcut recognition.

    5. Contact Support: If shortcuts still don't work, contact RentalTide support for further assistance.

Issue 4: Command Bar Dialog Not Displaying Correctly

  • Possible Cause: CSS conflicts, rendering issues, or component loading failures.

  • Solution:

    1. Refresh the Page: Reload the application to reset the UI components.

    2. Disable Browser Extensions: Some extensions might interfere with the rendering of dialogs. Disable them and try again.

    3. Clear Browser Cache: Clear your browser’s cache to remove any corrupted styles or cached data.

    4. Check for Updates: Ensure that your browser is up-to-date to support the latest web technologies used by the Command Bar.

    5. Contact Support: If the dialog still doesn't display correctly, reach out to RentalTide support with screenshots and details.

Issue 5: Unable to Navigate to Target Pages via Command Bar

  • Possible Cause: Incorrect navigation paths, insufficient permissions, or routing issues within the application.

  • Solution:

    1. Verify Navigation Paths: Ensure that the nav paths defined for each command correspond to valid routes within the application.

    2. Check Permissions: Confirm that your user account has the necessary permissions to access the target pages.

    3. Inspect Console for Routing Errors: Look for any routing-related errors in the developer console.

    4. Retry Navigation: Attempt to navigate again after ensuring all paths and permissions are correct.

    5. Contact Support: If navigation issues persist, contact RentalTide support with specific details about the problem.

Issue 6: Special Commands Not Performing Expected Actions

  • Possible Cause: Errors within the command's onSelect functions, such as incorrect function implementations or network issues.

  • Solution:

    1. Check Command Implementation: Ensure that the onSelect functions for special commands are correctly implemented and free of errors.

    2. Verify Network Connectivity: Some commands may require network access (e.g., redirecting to external sites).

    3. Inspect Console for Errors: Look for any JavaScript errors that might prevent the command from executing.

    4. Retry the Action: Attempt the command again after addressing any identified issues.

    5. Contact Support: If special commands still fail to perform as expected, reach out to RentalTide support with specific error details.

Related Articles
POS Reporting Page User Guide
Users Page User Guide
Profile Page User Guide
Business Page (Brand) User Guide
Sidebar User Guide
Did this answer your question?