The PageLink component is used to create clickable links that navigate to other pages within your app. Use PageLink for internal page navigation and the standard Link component for external URLs.
To use this component, you’ll need to be on version 0.13.0 or later of the ui-extensions NPM package. You can check your current version by running npm list or npm list -g, and install the latest version by running npm i @hubspot/ui-extensions.
Basic usage
Here’s a complete example showing how to use PageLink within a page component:
Props
Examples
Simple page navigation
Navigation with query parameters
Navigation with path parameters
PageLink vs Link
Use the right component for your navigation needs:
Guidelines
- DO: use
PageLink for all navigation between pages within your app.
- DO: use descriptive link text that clearly indicates where the link leads.
- DO: use the
params prop for passing data through URLs.
- DON’T: use
PageLink for external URLs - use the standard Link component instead.
- DON’T: use
PageLink for actions that aren’t navigation (use Button with onClick instead).