Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
neilime authored and github-actions[bot] committed Feb 9, 2024
1 parent c70d606 commit 71cd42d
Show file tree
Hide file tree
Showing 9 changed files with 48 additions and 48 deletions.
11 changes: 5 additions & 6 deletions development.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,26 @@ sidebar_position: 1

## Setup

`PHP_VERSION` is the version of php to use during the development. Example: `8.3`
Default PHP version is 8.3. You can override it by setting `PHP_VERSION` as Makefile argument. Example: `make PHP_VERSION=8.0 setup`.

```sh
make build-php PHP_VERSION
make install PHP_VERSION
make setup
```

## Running tests

```sh
make test PHP_VERSION
make test
```

## Fix code linting

```sh
make lint-fix PHP_VERSION
make lint-fix
```

## Running CI scripts

```sh
make ci PHP_VERSION
make ci
```
4 changes: 2 additions & 2 deletions usage/components/dropdowns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1155,7 +1155,7 @@ echo $this->dropdown()->renderMenu([
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<ul class="dropdown-menu">
<li>
<form action="" class="px-4 py-3" id="dropdown" method="POST" name="dropdown" role="form">
<form class="px-4 py-3" id="dropdown" method="POST" name="dropdown" role="form">
<div class="mb-3">
<label class="form-label" for="exampleDropdownFormEmail1">Email address</label>
<input class="form-control" id="exampleDropdownFormEmail1" name="email" placeholder="[email protected]" type="email" value="">
Expand All @@ -1178,7 +1178,7 @@ echo $this->dropdown()->renderMenu([
<li><a class="dropdown-item" href="#">Forgot password?</a></li>
</ul>
<br>
<form action="" class="dropdown-menu p-4" id="dropdown" method="POST" name="dropdown" role="form">
<form class="dropdown-menu p-4" id="dropdown" method="POST" name="dropdown" role="form">
<div class="mb-3">
<label class="form-label" for="exampleDropdownFormEmail1">Email address</label>
<input class="form-control" id="exampleDropdownFormEmail1" name="email" placeholder="[email protected]" type="email" value="">
Expand Down
4 changes: 2 additions & 2 deletions usage/components/modal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -867,7 +867,7 @@ echo $this->modal(
<button aria-label="Close" class="btn-close" data-bs-dismiss="modal" name="button" type="button" value=""></button>
</div>
<div class="modal-body">
<form action="" id="form" method="POST" name="form" role="form">
<form id="form" method="POST" name="form" role="form">
<div class="mb-3">
<label class="form-label" for="recipient-name">Recipient:</label>
<input class="form-control" id="recipient-name" name="recipient" type="text" value="">
Expand All @@ -885,7 +885,7 @@ echo $this->modal(
</div>
</div>
</div>
<script type="text/javascript"></script>` }}></div>
<script></script>` }}></div>
</HtmlCode>
</TabItem>
<TabItem value="source" label="Source">
Expand Down
26 changes: 13 additions & 13 deletions usage/components/navbar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ import HtmlCode from "../../../src/components/HtmlCode.tsx";
<a aria-disabled="true" class="disabled nav-link" href="#" tabindex="-1">Disabled</a>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-success" name="submit" type="submit" value="">Search</button>
</form>
Expand Down Expand Up @@ -433,7 +433,7 @@ echo $this->navigation()->navbar()->render(
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<nav class="bg-light navbar navbar-light">
<div class="container-fluid">
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-success" name="submit" type="submit" value="">Search</button>
</form>
Expand All @@ -443,15 +443,15 @@ echo $this->navigation()->navbar()->render(
<nav class="bg-light navbar navbar-light">
<div class="container-fluid">
<a class="navbar-brand" href="#">Navbar</a>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="element" placeholder="Search" type="search" value="">
<button class="btn btn-outline-success" name="submit" type="submit" value="">Search</button>
</form>
</div>
</nav>
<br>
<nav class="bg-light navbar navbar-light">
<form action="" class="container-fluid" id="form" method="POST" name="form" role="form">
<form class="container-fluid" id="form" method="POST" name="form" role="form">
<div class="input-group">
<span class="input-group-text" id="basic-addon1">@</span>
<input aria-describedby="basic-addon1" aria-label="Username" class="form-control" name="element" placeholder="Username" type="text" value="">
Expand All @@ -460,7 +460,7 @@ echo $this->navigation()->navbar()->render(
</nav>
<br>
<nav class="bg-light navbar navbar-light">
<form action="" class="container-fluid justify-content-start" id="form" method="POST" name="form" role="form">
<form class="container-fluid justify-content-start" id="form" method="POST" name="form" role="form">
<button class="btn btn-outline-success me-2" name="main_button" type="button" value="">Main button</button>
<button class="btn btn-outline-secondary btn-sm" name="smaller_button" type="button" value="">Smaller button</button>
</form>
Expand Down Expand Up @@ -731,7 +731,7 @@ echo $this->navigation()->navbar()->render(
<a class="nav-link" href="#">About</a>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-light" name="submit" type="submit" value="">Search</button>
</form>
Expand All @@ -758,7 +758,7 @@ echo $this->navigation()->navbar()->render(
<a class="nav-link" href="#">About</a>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-light" name="submit" type="submit" value="">Search</button>
</form>
Expand All @@ -785,7 +785,7 @@ echo $this->navigation()->navbar()->render(
<a class="nav-link" href="#">About</a>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-primary" name="submit" type="submit" value="">Search</button>
</form>
Expand Down Expand Up @@ -1019,7 +1019,7 @@ foreach (
<a aria-disabled="true" class="disabled nav-link" href="#" tabindex="-1">Link</a>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-success" name="submit" type="submit" value="">Search</button>
</form>
Expand Down Expand Up @@ -1124,7 +1124,7 @@ echo $this->navigation()->navbar()->render(
<a aria-disabled="true" class="disabled nav-link" href="#" tabindex="-1">Disabled</a>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-success" name="submit" type="submit" value="">Search</button>
</form>
Expand All @@ -1148,7 +1148,7 @@ echo $this->navigation()->navbar()->render(
<a aria-disabled="true" class="disabled nav-link" href="#" tabindex="-1">Disabled</a>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-success" name="submit" type="submit" value="">Search</button>
</form>
Expand All @@ -1172,7 +1172,7 @@ echo $this->navigation()->navbar()->render(
<a aria-disabled="true" class="disabled nav-link" href="#" tabindex="-1">Disabled</a>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-success" name="submit" type="submit" value="">Search</button>
</form>
Expand Down Expand Up @@ -1360,7 +1360,7 @@ echo $this->navigation()->navbar()->render(
</ul>
</li>
</ul>
<form action="" class="d-flex" id="form" method="POST" name="form" role="form">
<form class="d-flex" id="form" method="POST" name="form" role="form">
<input aria-label="Search" class="form-control me-2" name="search" placeholder="Search" type="search" value="">
<button class="btn btn-outline-success" name="submit" type="submit" value="">Search</button>
</form>
Expand Down
6 changes: 3 additions & 3 deletions usage/forms/floating-labels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ import HtmlCode from "../../../src/components/HtmlCode.tsx";
<input class="form-control" id="floatingPassword" name="password" placeholder="Password" type="password" value="">
<label for="floatingPassword">Password</label>
</div>
<form action="" id="form" method="POST" name="form" role="form">
<form id="form" method="POST" name="form" role="form">
<div class="form-floating">
<input class="form-control" id="floatingInputValue" name="emailWithValue" placeholder="[email protected]" type="email" value="[email protected]">
<label for="floatingInputValue">Input with value</label>
</div>
</form>
<form action="" class="was-validated" id="form" method="POST" name="form" role="form">
<form class="was-validated" id="form" method="POST" name="form" role="form">
<div class="form-floating has-error">
<input class="form-control is-invalid" id="floatingInputInvalid" name="invalidEmailWithValue" placeholder="[email protected]" type="email" value="[email protected]">
<div class="invalid-feedback"></div>
Expand Down Expand Up @@ -243,7 +243,7 @@ echo $this->formRow($factory->create(
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="g-2 row">
<div class="col-md form-floating">
<input class="form-control" id="floatingInputGrid" name="floatingInputGrid" placeholder="[email protected]" type="email" value="[email protected]">
Expand Down
8 changes: 4 additions & 4 deletions usage/forms/form-controls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import HtmlCode from "../../../src/components/HtmlCode.tsx";
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="mb-3">
<label class="form-label" for="exampleFormControlInput1">Email address</label>
<input class="form-control" id="exampleFormControlInput1" name="email" placeholder="[email protected]" type="email" value="">
Expand Down Expand Up @@ -217,7 +217,7 @@ echo $this->formElement($element);
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="mb-3 row">
<label class="col-form-label col-sm-2" for="staticEmail">Email</label>
<div class="col-sm-10">
Expand All @@ -232,7 +232,7 @@ echo $this->formElement($element);
</div>
</form>
<br>
<form action="" class="align-items-center row" id="form" method="POST" name="form" role="form">
<form class="align-items-center row" id="form" method="POST" name="form" role="form">
<label class="visually-hidden" for="staticEmail2">Email</label>
<div class="col-auto">
<input class="form-control-plaintext" id="staticEmail2" name="email" readonly type="email" value="[email protected]">
Expand Down Expand Up @@ -351,7 +351,7 @@ echo $this->form($factory->create([
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="mb-3">
<label class="form-label" for="formFile">Default file input example</label>
<input class="form-control" id="formFile" name="default-file" type="file">
Expand Down
20 changes: 10 additions & 10 deletions usage/forms/layout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import HtmlCode from "../../../src/components/HtmlCode.tsx";
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="mb-3">
<label class="form-label" for="formGroupExampleInput">Example label</label>
<input class="form-control" id="formGroupExampleInput" name="exampleLabel" placeholder="Example input placeholder" type="text" value="">
Expand Down Expand Up @@ -79,7 +79,7 @@ echo $this->form($factory->create([
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="row">
<div class="col">
<input aria-label="First name" class="form-control" name="firstName" placeholder="First name" type="text" value="">
Expand Down Expand Up @@ -139,7 +139,7 @@ echo $this->form($factory->create([
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="g-3 row">
<div class="col">
<input aria-label="First name" class="form-control" name="firstName" placeholder="First name" type="text" value="">
Expand All @@ -149,7 +149,7 @@ echo $this->form($factory->create([
</div>
</div>
</form>
<form action="" id="form" method="POST" name="form" role="form">
<form id="form" method="POST" name="form" role="form">
<div class="g-3 row">
<div class="col-md-6">
<label class="form-label" for="inputEmail4">Email</label>
Expand Down Expand Up @@ -376,7 +376,7 @@ echo $this->form($factory->create([
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="mb-3 row">
<label class="col-form-label col-sm-2" for="inputEmail3">Email</label>
<div class="col-sm-10">
Expand Down Expand Up @@ -530,7 +530,7 @@ echo $this->form($factory->create([
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="mb-3 row">
<label class="col-form-label col-form-label-sm col-sm-2" for="colFormLabelSm">Email</label>
<div class="col-sm-10">
Expand Down Expand Up @@ -621,7 +621,7 @@ echo $this->form($factory->create([
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="g-3 row">
<div class="col-sm-7">
<input aria-label="City" class="form-control" name="city" placeholder="City" type="text" value="">
Expand Down Expand Up @@ -702,7 +702,7 @@ echo $this->form($factory->create([
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form id="form" method="POST" name="form" role="form">
<div class="align-items-center gx-3 gy-2 row">
<div class="col-auto">
<label class="visually-hidden" for="autoSizingInput">Name</label>
Expand Down Expand Up @@ -736,7 +736,7 @@ echo $this->form($factory->create([
</div>
</form>
<br>
<form action="" id="form" method="POST" name="form" role="form">
<form id="form" method="POST" name="form" role="form">
<div class="align-items-center gx-3 gy-2 row">
<div class="col-sm-3">
<label class="visually-hidden" for="specificSizeInputName">Name</label>
Expand Down Expand Up @@ -962,7 +962,7 @@ echo $this->form($factory->create([
<Tabs>
<TabItem value="result" label="Result" default>
<HtmlCode bootstrapVersion="5.1">
<div dangerouslySetInnerHTML={{ __html: `<form action="" class="align-items-center g-3 row row-cols-lg-auto" id="form" method="POST" name="form" role="form">
<div dangerouslySetInnerHTML={{ __html: `<form class="align-items-center g-3 row row-cols-lg-auto" id="form" method="POST" name="form" role="form">
<label class="visually-hidden" for="inlineFormInputGroupUsername">Username</label>
<div class="col-12">
<div class="input-group">
Expand Down
Loading

0 comments on commit 71cd42d

Please sign in to comment.