Download the PHP package amjadiqbal/laravel-rough-notation without Composer
On this page you can find all versions of the php package amjadiqbal/laravel-rough-notation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download amjadiqbal/laravel-rough-notation
More information about amjadiqbal/laravel-rough-notation
Files in amjadiqbal/laravel-rough-notation
Package laravel-rough-notation
Short Description Beautiful hand-drawn animations for Laravel. A lightweight Rough Notation wrapper to circle, underline, and highlight elements in your Blade and Livewire applications.
License MIT
Homepage https://github.com/AmjadIqbal/laravel-rough-notation
Informations about the package laravel-rough-notation
Laravel Rough Notation
Beautiful hand-drawn animations for Laravel. A lightweight Rough Notation wrapper to circle, underline, and highlight elements in your Blade and Livewire applications.
Features
- Fluent
Notation::builder for creating annotations - Blade directives:
@annotate,@endannotate, and@roughNotationScripts - Supports types: underline, box, circle, highlight, strike-through, crossed-off, bracket
- Options: color, strokeWidth, padding, iterations, brackets, animationDuration
- Group multiple annotations to animate in sequence
Installation
Interactive Install
Run the guided installer:
Options:
- --cdn=true|false to select CDN vs local
- --publish-assets=true|false to download local ESM script
- --assets-path=public/vendor/rough-notation to pick destination path
- --open-link=true to open support/contact page
Example:
Publish Config and Assets
Publish the package config:
Publish local ESM script:
Quick Start
- Install:
composer require amjadiqbal/laravel-rough-notation - Guided install:
php artisan rough:install - Publish config:
php artisan vendor:publish --tag=rough-notation-config - Publish local ESM:
php artisan rough:publish-assets --path=public/vendor/rough-notation - Add scripts:
@roughNotationScripts - Annotate with directives, components, or the builder API
Setup
Add scripts to your layout:
Configuration (optional) published to config/rough-notation.php:
Requirements
- PHP 8.1+
- Laravel 11
Example Layout
Usage
Wrap any text or element:
With options:
Groups:
Chainable API (Non-Blade)
Blade Component
Basic component:
Typed components (namespaced):
Props:
- options: array of supported options
- group: string group id to sequence annotations
- tag: wrapper tag (defaults to span)
Demo Page
Types Gallery
Each example shows the directive and a short description.
-
underline:
-
box:
-
circle:
-
highlight:
-
strike-through:
-
crossed-off:
- bracket:
Livewire Usage
- The scripts directive auto re-initializes after Livewire updates.
- For manual re-init:
Testing
Examples
- Livewire: call
window.initRoughNotation()after component updates to re-init annotations on dynamic content. - Multiple groups: mix sequences by assigning different group ids to elements.
- Local assets: after
php artisan rough:publish-assets, setcdntofalsein config to import the local ESM.
Options Reference
- color: string color or hex
- strokeWidth: int line width
- padding: int inner padding in px
- iterations: int number of sketch strokes
- animationDuration: int in ms
- brackets: array|string (left|right|top|bottom) only for type=bracket
Screenshots
Contributing
- Follow PSR-12 code style
- Run tests before submitting changes
- Open a PR with a clear description
Changelog
See CHANGELOG.md.
License
MIT License. See LICENSE.
Support & Community
Custom Development
Hire me on Upwork for:
- Package integration
- Custom feature development
- Technical consultation
- Project implementation
Community Support
For priority support and enterprise solutions, please reach out via Upwork for direct assistance.
Author
Amjad Iqbal — amjad.com.pk · Discord · Upwork · GitHub
All versions of laravel-rough-notation with dependencies
illuminate/support Version ^11.0|^12.0|^13.0
illuminate/view Version ^11.0|^12.0|^13.0
illuminate/contracts Version ^11.0|^12.0|^13.0