@tollbrothers/blueprint
v1.10.0
Published
Toll Brothers Design System
Keywords
Readme
Blueprint: The Toll Brothers Design System
Overview
Blueprint is the comprehensive design system developed by Toll Brothers, aimed at ensuring consistency, efficiency, and excellence across all our digital products. This system serves as the foundation for creating a cohesive user experience that reflects the luxury and sophistication synonymous with the Toll Brothers brand.
Getting Started
Installation
To start using Blueprint in your project, follow these simple steps:
Install via npm:
npm install @tollbrothers/blueprintImport the styles:
import { ThemeProvider, defaultTheme, kragleTheme } from '@tollbrothers/blueprint'; // either use defaultTheme or kragleTheme or your own custom theme const App = () => ( <ThemeProvider theme={defaultTheme}>...</ThemeProvider> );Use the components:
import { Button } from '@tollbrothers/blueprint'; const MyComponent = () => ( <Button>Click Me</Button> );
Local Development
- From
blueprintpoint react and react-dom to local e.g.npm i ../whateverRepoYouAreTestingfor devDependencies and peerDependencies viafile:. - From
whateverRepoYouAreTestingpoint@tollbrothers/blueprintto the local directory viafile:.
To ensure proper resolution of dependencies, particularly for React, React DOM, and Material-UI, configure the paths in your jsconfig.json (or tsconfig.json if using TypeScript).
Update Your jsconfig.json:
{
"compilerOptions": {
"paths": {
"react": ["./node_modules/react"],
"react-dom": ["./node_modules/react-dom"]
}
}
}By explicitly defining paths in your jsconfig.json, you ensure that your project uses the correct instances of react, react-dom, and other dependencies. This prevents issues where your library might resolve these packages to its own node_modules instead of the consumer project's node_modules.
Codex
- Install / update
- Keep your npm line, but mention Homebrew (if they used it):
npm install -g @openai/codex@latest(macOS) brew update && brew upgrade codex
- Version check
✅ codex --version (aim for ≥ 0.49.0)
- Config file
Edit
~/.codex/config.tomlMake sure the flag is top-level, not inside [mcp_servers].
experimental_use_rmcp_client = true [mcp_servers.figma] url = "http://127.0.0.1:3845/mcp"
- Restart
- Quit and relaunch Codex (or your IDE extension).
- Figma setup
- Open Figma Desktop, switch on Dev Mode, and select a frame/layer (the MCP often needs an active selection).
- Verify the MCP wiring
get_design_context
Workflow
Example
Take a look at the src/mui/blocks/Overview directory. A directory was created and then the following files were created:
Overview.js- This is the component that will be used in the application.
Overview.module.scss- This is where the styles are defined for the component.
Overview.mockData.js- Mock data is used to simulate data that would be passed to the component.
Overview.stories.js- This is where the component is used in a storybook.
The flow goes like this:
Overview.module.scss is used by Overview.js
Overview.mockData.js is used by Overview.stories.js
Overview.stories.js is used by Storybook
Overview.js is used by Overview.stories.js and the applicationExample Tokens
If you want to see the tokens that are added to the page run npm run example-tokens. This will give the stylesheet that is built on the page.
