bearly/ui

A set of grizzly UI components to drop into your app.

0.1.0 2024-03-08 21:23 UTC

Requires

• php: ^8.2
• illuminate/support: ^10.0
• laravel/prompts: ^0.1.0

Requires (Dev)

• livewire/livewire: ^3.1
• orchestra/testbench: ^8.15

MIT

• Austen Cameron

README

Grizzly UI components for Laravel Blade and Livewire.

You can use the components in several ways

• Directly from the composer package - (i.e. <x-input ...>)
• By copying the blade components into your project - (i.e. <x-input ...>)

In either case, it's recommended to include the Tailwind plugin for the best experience.

Installation

Requirements

This package is built for Laravel and Livewire and Tailwind CSS, it requires:

• Laravel 10.x
• Livewire 3.x
• Tailwind CSS 3.x (if using the Tailwind plugin)
• Tailwind CSS Forms Plugin

How to Install

Add the repository to your composer.json file:

This step is temporary (because this isn't on packagist yet), and will be removed once the package is published.

"repositories": [
    {
        "type": "git",
        "url": "https://github.com/bearly-ui/ui"
    }
],

Install the package with composer, and the Tailwind CSS forms plugin:

composer require bearly/ui:dev-main
npm i --save-dev @tailwindcss/forms

Next, add the tailwind plugin to your tailwind.config.js file.

import forms from '@tailwindcss/forms'
import bearUI from './vendor/bearly/ui/ui'

// Currently Bear UI only supports ESM -- PRs welcome!
export default {
    // This is a workaround right now until I figure out how to get the
    // Tailwind plugin to configure its own content path automatically
    content: [
        // ...
        './vendor/bearly/ui/resources/**/*.blade.php'
    ],
    // ...
    plugins: [forms, bearUI],
}

Run the build and start using the components:

npm run dev

Either directly from the package, or copy them into your project.

Usage

Using the components

You can use the components directly from the package by prefixing them with x-ui:::

<x-input />

Copying the components

WIP

Development Setup

Install dependencies

Clone the repository and install dependencies:

git clone [e-mail]:bearly-ui/ui.git
cd ./ui
npm install
composer install

Running the tests

With dependencies installed you should be able to run the tests with ./vendor/bin/phpunit