DanielRSnell / broke-bricks

This is a child theme that serves as a companion to Bricks Builder the enables many unique features for the builder and development experience.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Broke Bricks - A Bricks Builder Child Theme 🧱

Broke Bricks is an innovative child theme for Bricks Builder, designed to supercharge your building experience with enhanced flexibility, performance, and creativity. It's perfect for developers and designers who love to craft their components and interfaces with precision and semantic structure.

πŸš€ Features

Broke Bricks comes packed with features that make it a powerhouse for web development:

  • Autogenerated Admin Options for Scripts: Easily enqueue or dequeue JavaScript files right from the theme settings. πŸ“
  • Framework Presets: Includes popular frameworks like Alpine, HTMX, GSAP, and more, ready to be enabled with just a click. πŸ—οΈ
  • Alpine & HTMX Core.js: Recommended for creating highly interactive and custom interfaces effortlessly. ⚑
  • HTMX Hot Swap with Bricks Components: Enhance your Bricks components with HTMX hot swapping. πŸ”„
  • Semantic Structure Building: Focus on creating components using semantic HTML. πŸ› οΈ
  • Bricksbender Plugin Compatibility: Easily import any pre-made HTML/Alpine structures. 🧲
  • Tailwind Mode: Strip away all default Bricks styling for enhanced performance. πŸŒͺ️
  • Disable "bricksJS" on the Frontend: Gain more control by disabling "bricksJS" when using libraries like Alpine or HTMX. πŸ”Œ
  • Toggle Elements On/Off: Effortlessly manage which elements appear in the Bricks builder. πŸŽ›οΈ
  • Timber/Twig Integration: Access Timber and Twig within the Bricks editor or from the theme level for unprecedented control and flexibility. 🌲
  • Cwicly Migration Mode: A new admin setting option that brings in Cwicly's CSS/JS, enhancing the experience when using Tailwind Mode. Recommended for seamlessly transferring components from Cwicly to Bricks. πŸ”„

Cwicly Migration Mode

Utilize "Cwicly Migration Mode" in conjunction with the Bricksbender plugin to easily migrate your components from Cwicly into Bricks. Follow these steps for a smooth transition:

  1. On your Cwicly site, disable all performance plugins.
  2. Navigate to the page you wish to convert, and open it on the frontend.
  3. Use the inspector to copy the section/component from the DOM.
  4. Use Bricksbender to paste it into Bricks.

Caveats

  • Dynamic components will need to be set to dynamic.
  • Post-specific styling, such as on dynamic items, will not be applied. Consider adding a Tailwind grid/flex layout to the element.
  • Remove any additional dynamic items, ensuring only 1 item is repeating in the query.
  • Any other post-specific styling required will either need to be switched to Tailwind, or you can copy over the styling into the child theme and enqueue it.

Read the Cwicly Bricks Migration Guide for more detailed information.

Timber/Twig Integration Highlights

  • Remote Data Requests: Fetch and display data from any source directly within your Bricks pages.
  • Custom Function Granularity: Gain detailed control over your site's functionality with custom PHP functions.
  • Custom WooCommerce Queries: Implement custom queries with better naming conventions for a smoother WooCommerce integration.
  • Timber Context Access: Tap into the Timber context at any time for greater control over page conditions.

Note: Live preview for Twig in the Bricks Editor is a planned feature and will be available in future updates.

πŸ“˜ Recommended Usage

To harness the full power of Broke Bricks, we suggest:

  • Enabling Alpine and HTMX: Build interactive and responsive interfaces with minimal effort.
  • Activating Tailwind Mode: Ensure your site is as lightweight and fast as possible.
  • Disabling Default Bricks Styling: Boost your site's performance and customize your design approach.
  • Exploring Semantic Building: Build components from scratch for a more tailored experience.

πŸ“š Documentation

For more detailed information on each feature and tips on getting the most out of Broke Bricks, refer to our documentation.

🀝 Contributing

We welcome contributions! If you have suggestions or want to improve Broke Bricks, please feel free to submit a pull request or open an issue.

About

This is a child theme that serves as a companion to Bricks Builder the enables many unique features for the builder and development experience.


Languages

Language:PHP 46.7%Language:CSS 44.4%Language:JavaScript 7.7%Language:HTML 1.1%Language:Twig 0.1%