Skip to content
This repository was archived by the owner on Mar 18, 2025. It is now read-only.

Commit 5ecdd00

Browse files
committed
Update docs to use placeholders
1 parent 5b4d885 commit 5ecdd00

File tree

12 files changed

+25
-25
lines changed

12 files changed

+25
-25
lines changed

docs/files/filepond.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Before using this component, we recommend familiarizing yourself with the FilePo
1010

1111
## Installation
1212

13-
While the `file-pond` component works out-of-the-box when you've [set the directive](/docs/laravel-form-components/v5/installation#directives),
13+
While the `file-pond` component works out-of-the-box when you've [set the directive](/docs/laravel-form-components/{version}/installation#directives),
1414
we recommend that you install and compile the JavaScript libraries before you deploy to production:
1515

1616
- [Alpine.js](https://github.com/alpinejs/alpine) `^2.8`

docs/inputs/date-picker.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ By using it, you can simply add a date and/or time picker to your form with one
1010

1111
## Installation
1212

13-
While the `date-picker` component works out-of-the-box when you've [set the directives](/docs/laravel-form-componentsvalue-fieldinstallation#directives),
13+
While the `date-picker` component works out-of-the-box when you've [set the directives](/docs/laravel-form-components/installation#directives),
1414
we recommend that you install and compile the JavaScript libraries before you deploy to production:
1515

1616
- [Alpine.js](https://github.com/alpinejs/alpine) `^2.8`
@@ -62,7 +62,7 @@ that flatpickr generates. If you want to prevent the button/icon from being disp
6262
> {note} If you disable the toggle button, be sure to set `click-opens` to `true` on the component.
6363
6464
> {tip} You can also change the icon that is used for the toggle button either by setting the `toggle-icon` attribute, or by changing
65-
> it globally [in the config](https://github.com/rawilk/laravel-form-components/blob/master/config/form-components.php#L103).
65+
> it globally [in the config](https://github.com/rawilk/laravel-form-components/blob/{branch}/config/form-components.php#L103).
6666
6767
## Clearing
6868

@@ -73,7 +73,7 @@ to `true` and an icon for clearing the input will be appended to the input.
7373
<x-date-picker name="birthday" clearable />
7474
```
7575

76-
The icon defaults to `heroicon-o-x-circle`, but you can easily customize this icon either [in the config](https://github.com/rawilk/laravel-form-components/blob/master/config/form-components.php#L109), or by setting the `clear-icon` attribute to the icon you want.
76+
The icon defaults to `heroicon-o-x-circle`, but you can easily customize this icon either [in the config](https://github.com/rawilk/laravel-form-components/blob/{branch}/config/form-components.php#L109), or by setting the `clear-icon` attribute to the icon you want.
7777

7878
## Options
7979

@@ -133,4 +133,4 @@ For more information on the callbacks available, please consult [the events api]
133133
Like the other inputs, the date picker can also have leading and trailing addons, however by default you cannot add them.
134134
To add leading addons, you must disable the toggle icon, and for trailing addons, you must set `clearable` to `false`.
135135

136-
See the [input documentation](/docs/laravel-form-components/v5/inputs/input#addons) for more information.
136+
See the [input documentation](/docs/laravel-form-components/{version}/inputs/input#addons) for more information.

docs/inputs/email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ The most basic usage of the component is like this:
2020
By default an `email` type will be set for the input field as well as an `id` that allows it to be
2121
easily referenced by a `label` element.
2222

23-
Besides this, the email element behaves exactly the same as the [input component](/docs/laravel-form-components/v5/inputs/input).
23+
Besides this, the email element behaves exactly the same as the [input component](/docs/laravel-form-components/{version}/inputs/input).

docs/inputs/input.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ When there are errors for a field, the `aria-invalid` and `aria-describedby` att
5959
```
6060

6161
The actual error message won't be rendered from the input component itself, but it can be automatically rendered for you
62-
by wrapping the `<x-input />` component inside of a `<x-form-group />` component. Please refer to the [form-group documentation](/docs/laravel-form-components/v5/form/form-group#error-handling) for more information.
62+
by wrapping the `<x-input />` component inside of a `<x-form-group />` component. Please refer to the [form-group documentation](/docs/laravel-form-components/{version}/form/form-group#error-handling) for more information.
6363

6464
The `aria-describedby` attribute takes the `name` attribute and appends `-error` to it, which will be the id given to the error message rendered by the `<x-form-group />` component. If you already have `aria-describedby` set on the input, the attribute
6565
value will be merged with the error attribute value.

docs/inputs/password.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ Like the other inputs, the password input can also have leading addons, but sinc
7171
includes a password toggle as a trailing icon addon, you are not able to add a trailing addon
7272
to the password input. If you need a trailing addon, you should use the input component instead.
7373

74-
See the [input documentation](/docs/laravel-form-components/v5/inputs/input#addons) for more information.
74+
See the [input documentation](/docs/laravel-form-components/{version}/inputs/input#addons) for more information.

docs/inputs/switch-toggle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ for more info.
1212

1313
## Installation
1414

15-
While the `switch-toggle` component works out-of-the-box when you've [set the directive](/docs/laravel-form-components/v5/installation#directives),
15+
While the `switch-toggle` component works out-of-the-box when you've [set the directive](/docs/laravel-form-components/{version}/installation#directives),
1616
we recommend that you install and compile the JavaScript libraries before you deploy to production:
1717

1818
- [Alpine.js](https://github.com/alpinejs/alpine) `^2.8`
@@ -120,7 +120,7 @@ These sizes also come in responsive variants, so if you wanted the switch small
120120
<x-switch-toggle class="switch-toggle--sm lg:switch-toggle--lg" />
121121
```
122122

123-
You are free to add your own sizes in your own stylesheets. Just reference the [switch toggle styles](https://github.com/rawilk/laravel-form-components/blob/master/resources/sass/utils/_switch.scss#L126) for guidance.
123+
You are free to add your own sizes in your own stylesheets. Just reference the [switch toggle styles](https://github.com/rawilk/laravel-form-components/blob/{branch}/resources/sass/utils/_switch.scss#L126) for guidance.
124124

125125
## Icons
126126

docs/inputs/textarea.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,5 @@ If you are using livewire, the textarea will allow livewire to set the value ins
4444

4545
## Reference
4646

47-
Since the textarea component extends the [input component](/docs/laravel-form-components/v5/inputs/input), you are able
47+
Since the textarea component extends the [input component](/docs/laravel-form-components/{version}/inputs/input), you are able
4848
to do a lot of the same things you can with the input element, such as error handling and addons.

docs/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You may publish the config file via:
2727
php artisan fc:publish
2828
```
2929

30-
[Click here](https://github.com/rawilk/laravel-form-components/blob/master/config/form-components.php) to view the default configuration.
30+
[Click here](https://github.com/rawilk/laravel-form-components/blob/{branch}/config/form-components.php) to view the default configuration.
3131

3232
## Directives
3333

@@ -86,9 +86,9 @@ This is assuming your stylesheet is located in the `./resources/css/` directory
8686

8787
You could copy the built CSS from `vendor/rawilk/laravel-components/resources/js/laravel-form-components-styles/dist/styles.css` into your public folder, and then use a `link` tag in your blade/html to get it: `<link rel="stylesheet" href="{{ asset('css/laravel-form-components.css') }}">`.
8888

89-
If you would like to customize the CSS we provide, head over to [the section on Customizing CSS](/docs/laravel-form-components/v5/advanced-usage/customizing-css).
89+
If you would like to customize the CSS we provide, head over to [the section on Customizing CSS](/docs/laravel-form-components/{version}/advanced-usage/customizing-css).
9090

91-
> {tip} If you are using Purge CSS or Tailwind's JIT compiler, you should check out the section on [Purge CSS](/docs/laravel-form-components/v5/advanced-usage/customizing-css#purge-csstailwind-jit)
91+
> {tip} If you are using Purge CSS or Tailwind's JIT compiler, you should check out the section on [Purge CSS](/docs/laravel-form-components/{version}/advanced-usage/customizing-css#purge-csstailwind-jit)
9292
> to prevent styles from being lost in production or at compile time.
9393
9494
## Components
@@ -104,7 +104,7 @@ and/or view of your own.
104104

105105
## Component JavaScript
106106

107-
Some components, such as the [custom select component](/docs/laravel-form-components/v5/selects/custom-select), require custom
107+
Some components, such as the [custom select component](/docs/laravel-form-components/{version}/selects/custom-select), require custom
108108
JavaScript to run. The JavaScript is extracted to an external file since it is pretty substantial and should be minified. If
109109
you are using any components that depend on this JavaScript, be sure you are pulling the scripts in through either the
110110
`@fcJavaScript` or `@fcScripts` blade directives in your layout file. See [directives](#directives) for more information.

docs/selects/custom-select.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ custom option markup while still providing usability functionalities such as key
1212
## Installation
1313

1414
The custom select component requires Alpine.js and Popper.js, as well as some custom JavaScript written into the package to work.
15-
Ensure you have the proper [directives](/docs/laravel-form-componentsvalue-fieldinstallation#directives) in your layout file.
15+
Ensure you have the proper [directives](/docs/laravel-form-components/installation#directives) in your layout file.
1616
In production, we recommend you install and compile the JavaScript libraries before you deploy:
1717

1818
- [Alpine.js](https://github.com/alpinejs/alpine) `^2.8`
1919
- [Popper.js](https://popper.js.org/) `^2.9.1`
2020

21-
> {tip} See the [JavaScript Dependencies section](/docs/laravel-form-components/v5/installation#javascript-dependencies) for more information on installing them.
21+
> {tip} See the [JavaScript Dependencies section](/docs/laravel-form-components/{version}/installation#javascript-dependencies) for more information on installing them.
2222
2323
## Basic Usage
2424

@@ -234,4 +234,4 @@ the select menu now. In addition to positioning the menu when opened, Popper.js
234234
## Addons
235235

236236
The custom select component supports leading addons, but since there are already elements appended to the end
237-
of the button trigger, trailing addons are not supported. For more information on addons, see [the input documentation](/docs/laravel-form-components/v5/inputs/input#addons).
237+
of the button trigger, trailing addons are not supported. For more information on addons, see [the input documentation](/docs/laravel-form-components/{version}/inputs/input#addons).

docs/selects/select.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,5 +82,5 @@ You can easily create a multiple select by setting `multiple` to `true`:
8282

8383
## Reference
8484

85-
Since the select component extends the [input component](/docs/laravel-form-components/v5/inputs/input), you are able
85+
Since the select component extends the [input component](/docs/laravel-form-components/{version}/inputs/input), you are able
8686
to do a lot of the same things you can with the input element, such as error handling and addons.

0 commit comments

Comments
 (0)