Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 3.36 KB

README.md

File metadata and controls

71 lines (45 loc) · 3.36 KB
Raw

foundry-js-blueprint-react

React blueprint for Foundry UI application development.

Getting started

  • npm install
  • npm run watch

npm run watch will start Rollup in watch mode and your application's output will be under /src/dist. The contents of src/dist is what will be rendered by Foundry.

UI development

Included in this blueprint are some common css and React components you can use in your app. They're already styled to be consistent with the rest of Falcon Console and handle light and dark mode for you.

  • Shoelace is already installed and we've also included shoelace specific Falcon css to make the components provided by Shoelace look consistent with the rest of Falcon.

  • Tailwind Toucan Base is a tailwindcss theme that gives you utility classes you can use in html or React components. You have the full power of tailwind in this boilerplate. The Falcon specific colors are a great place to start in Tailwind Toucan Base.

Routing

This blueprint provides a Link component to help with routing in your Extension or Page and within Falcon Console.

The <Link> component accepts two props:

  • to - the path to navigate to
  • useFalconNavigation - a boolean value indicating whether or not a link click will update the Falcon Console url. Defaults to false

Setting useFalconNavigation to true will send the user to a new location within Falcon Console (this changes the Falcon Console url in the user's browser)

By default useFalconNavigation is set to false and React Router (included in this blueprint) will handle user navigation and UI changes within your app.

Usage of the <Link> component can be seen in the home and navigation components.

import { Link } from '../components/link';

// navigates to https://falcon.crowdstrike.com/crowdscore
<Link useFalconNavigation={true} to="/crowdscore">Crowdscore</Link>

// navigates to an /about route within your Extension or Page 
<Link to="/about">Crowdscore</Link>

Building your app

Before deploying your Foundry app, you must do a final build of your UI extension so the app has access to the latest files in /src/dist. Run the following build command when you're ready to deploy:

  • npm run build

Adding entries to your manifest's ignored field

When deploying your app, the dist directory is required and everything else can be ignored.

Below are some starter regex patterns you can add to your app's manifest.yml file.

ignored:
    - ui/(extensions|pages)/[^\/]*?/public
    - ui/(extensions|pages)/[^\/]*?/index.html
    - ui/(extensions|pages)/[^\/]*?/favicon.ico
    - ui/(extensions|pages)/.*?/node_modules
    - ui/(extensions|pages)/.*?/config
    - ui/(extensions|pages)/.*?/\.gitignore
    - ui/(extensions|pages)/.*?/package\.json
    - ui/(extensions|pages)/.*?/tsconfig\.json
    - ui/(extensions|pages)/.*?/tsconfig\..*\.json
    - ui/(extensions|pages)/.*?/.*?\.(md|log|lock|cjs)

Here's an example of how to set your manifest's ignored field.