Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UI kit documentation #1520

Merged
merged 9 commits into from
Feb 2, 2024
Merged

Update UI kit documentation #1520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
540f0b9
Update newsletter-signup-example.blade.php
caendesilva Feb 2, 2024
b79b7ee
Update newsletter-signup-example.blade.php
caendesilva Feb 2, 2024
1257e30
Update newsletter-signup-example.blade.php
caendesilva Feb 2, 2024
c2aced9
Revert "Update newsletter-signup-example.blade.php"
caendesilva Feb 2, 2024
b2408ab
Revert "Update newsletter-signup-example.blade.php"
caendesilva Feb 2, 2024
8d33f27
Revert "Create newsletter-signup-example.blade.php"
caendesilva Feb 2, 2024
5037ca4
Update documentation.md
caendesilva Feb 2, 2024
3a26a8a
Update documentation.md
caendesilva Feb 2, 2024
4e3e70e
Formatting
caendesilva Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions packages/ui-kit/docs/_pages/examples/newsletter-signup-example.blade.php
View file
Open in desktop

This file was deleted.

12 changes: 9 additions & 3 deletions packages/ui-kit/docs/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,18 @@ The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCS
indented to be used with HydePHP. Note that these components may require CSS classes not present in the bundled app.css
file and that you may need to recompile the CSS file using the included Laravel Mix configuration.

## Preface
## Screenshot

Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/blade) before using the HydePHP UI Kit.
Here are some of the components you can use to build your next project! As you can see, all components support both light and dark mode out of the box, just like the rest of HydePHP.

>info Tip: Most components allow you to pass any additional HTML attributes to the element!
![Components Screenshot](https://raw.githubusercontent.com/hydephp/ui-kit/art/header-large-min.png)

## Components

Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/blade) before using the HydePHP UI Kit.

>info Tip: Most components allow you to pass any additional HTML attributes to the element!

### Buttons

#### Primary
Expand Down Expand Up @@ -156,3 +160,5 @@ You can get surprisingly far when you combine the components. Take this newslett
</x-slot>
</x-hyde-ui::card>
```

![Newsletter Screenshot](https://raw.githubusercontent.com/hydephp/ui-kit/art/newsletter-signup-example-min.png)
Loading