Skip to content

README.md

Latest commit

 

History

History
59 lines (44 loc) · 3.38 KB

README.md

File metadata and controls

59 lines (44 loc) · 3.38 KB

User Guide

Welcome to the user guide for the Yii Framework Bootstrap 5 package.

This guide helps you get started with the package, understand its components, and use them in your Yii applications.

Whether you're building a simple dropdown menu or a complex navigation bar, you will find clear instructions and examples here.

Getting Started

Before diving in, make sure you’ve installed the package.

Check the installation instructions in the main README for details.

You will need PHP 8.1 or higher and the yiisoft/bootstrap5 package installed via Composer.

Once you’re set up, explore the widget-specific guides below to start building.

Available Guides

  • Accordion: Learn how to create and customize an accordion component with various item types, toggle options.
  • Alert: Learn how to create and customize an alert component with variants, headers, and dismissible options.
  • Breadcrumbs: Learn how to create and customize breadcrumb navigation, including separators and links.
  • Button: Learn how to create and customize buttons with different variants, sizes, and states.
  • Button Group: Learn how to create and customize button groups for creating sets of related buttons displayed side by side.
  • Button Toolbar: Learn how to create button toolbars that combine multiple button groups to create complex control interfaces.
  • Carousel: Learn how to create interactive slideshows with custom content, captions, controls, and animation effects.
  • Collapse: Learn how to create togglable content sections that can be shown and hidden with a simple click.
  • Dropdown: Learn how to create and customize interactive dropdown menus with various item types, toggle options.
  • Modal: Learn how to create customizable dialog windows that temporarily block interactions with the main view.
  • Nav: Learn how to create and customize navigation components with different styles, layouts and interactive elements.
  • NavBar: Learn how to create responsive navigation headers with support for branding, navigation, and other elements.
  • Offcanvas: Learn how to create hidden sidebars that slide in from the edge of the screen for navigation or additional content.
  • Progress: Learn how to create and customize progress bars to display the completion status of tasks or operations.
  • Progress Stack: Learn how to create stacked progress bars for displaying multiple progress indicators in a single component.
  • Toast: Learn how to create and customize lightweight notifications that appear at the edge of the screen.

How to Use This Guide

Each section is designed to be standalone, so you can jump to the widget you need. You will find:

  • A quick start example to get you going.
  • Configuration options with code snippets.
  • Links to additional resources, like the Bootstrap 5 docs.

If something is unclear, feel free to ask for clarification on the Yii Forum.

Additional Resources