diff --git a/CHANGELOG.md b/CHANGELOG.md index 8b412b286..7dede0663 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to `laravel-livewire-tables` will be documented in this file +## [v3.4.18] - 2024-09-04 +### New Features +- Added translation to Polish by @meavric in https://github.com/rappasoft/laravel-livewire-tables/pull/1925 + +### Docs +- Added example for Vertical Scrolling table by @lrljoe in https://github.com/rappasoft/laravel-livewire-tables/pull/1926 + ## [v3.4.17] - 2024-09-01 ### New Features - Add hide table option by @lrljoe in https://github.com/rappasoft/laravel-livewire-tables/pull/1914 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4e9fea06..af96ac892 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,44 @@ # Contributing -Contributions are very welcome, please find below a summary of what is expected from contributions: +This package is maintained by a core team, backed by a strong community effort, and contributions are extremely welcome! -- Follow the conventions for methods, adding to the relevant configuration/helper trait -- Add properties to the "With" trait +Please find below a brief summary of how to make a good contribution. This helps to ensure a smooth review and merge of a PR. + +## Discussing A Feature +Please do feel free to raise a Discussion topic, a Feature Request Issue, or reach out on the official Discord to discuss any ideas! + +## Starting A Contribution +- Always create a fresh branch in your fork for every change. This should be based on the "development" branch, as other branches may be outdated, or lack the change history. +- Ensure that a PR contains a single feature/fix. PRs with multiple features often end up with merge conflicts! +- Avoid introducing a breaking change. If your change makes a radical or substantial change, then the existing behaviour should be maintained as the default. The core team tracks these, and as major versions are reached, may introduce new default behaviours. + +## Generic Information +- Avoid adding any additional dependencies/requirements to the package unless discussed and approved by the core team. - Typehint both properties and return values -- Add a comment to the method -- Add tests for new methods -- Add documentation for new methods \ No newline at end of file +- Add a comment to the method to explain what it does, this does not/should not be lengthy! + +## Views +- Where amending/appending to Views/Blades, ensure that you cater for Tailwind, Bootstrap-4 and Bootstrap-5 to ensure continued support + +## Tests +- Always add tests for new methods +- Review existing tests if you make changes. +- The project maintains a very high level of test coverage. A PR that reduces this coverage is less likely to be readily accepted. + +## Documentation +There is comprehensive documentation available for existing features. Please add documentation for any new/amended methods, as otherwise this may result in delays, which may be significant! + +## Conventions +- Please follow the project conventions below: + +### Core Features +A feature set typically exists in a "With" trait (For example - Rappasoft\LaravelLivewireTables\Traits\WithColumns.php) +- The "WithColumns" contains any properties, and any key methods +- Each feature set has a "Helper" and "Configuration" trait associated with it, for setting and getting properties, both server-side, and client-side. + +## Actions, Columns and Filters +An Action/Column/Filter type exists in the "Views" section (For example Rappasoft\LaravelLivewireTables\Views\Columns\DateColumn.php) +- Each Action/Column/Filter again has a "Helper" and "Configuration" trait associated with it, for setting and getting properties +- Actions should extend Rappasoft\LaravelLivewireTables\Views\Action (or a class that extends this) +- Columns should extend Rappasoft\LaravelLivewireTables\Views\Column (or a class that extends this) +- Filters should extend Rappasoft\LaravelLivewireTables\Views\Filter (or a class that extends this) + diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index ffd644706..ad1b2a7cb 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -18,6 +18,7 @@ | Indonesian (ID) | None | | Italian (IT) | Core Team | | Malay (MS) | [wanadri](https://github.com/wanadri) | +| Polish (PL) | [meavric](https://github.com/meavric) | | Portugese (PT) | None | | Russian (RU) | None | | Spanish (ES) | [CristhoferMF](https://github.com/CristhoferMF) | diff --git a/docs/datatable/styling.md b/docs/datatable/styling.md index 612cf7a47..38055dbd9 100644 --- a/docs/datatable/styling.md +++ b/docs/datatable/styling.md @@ -386,3 +386,21 @@ public function configure(): void ]); } ``` + +### Vertical Scrolling Example +Should you wish to implement a table with a responsive height, and vertical scrolling for additional rows, a basic example is below that demonstrates the approach, noting that you will likely wish to adjust the break-points! + +```php +public function configure(): void +{ + + $this->setTableWrapperAttributes([ + 'class' => 'max-h-56 md:max-h-72 lg:max-h-96 overflow-y-scroll', + ]); + $this->setTheadAttributes([ + 'class' => 'sticky top-0 ' + ]); +} +``` + +Keep in mind that you must only call methods from configure() once to avoid overriding or conflicting results. \ No newline at end of file diff --git a/resources/lang/pl.json b/resources/lang/pl.json new file mode 100644 index 000000000..70e99e7f3 --- /dev/null +++ b/resources/lang/pl.json @@ -0,0 +1,33 @@ +{ + "All": "Wszystko", + "All Columns": "Wszystkie kolumny", + "Applied Filters": "Użyte filtry", + "Applied Sorting": "Użyte sortowanie", + "Bulk Actions": "Akcje zbiorowe", + "Bulk Actions Confirm": "Czy zastosować ?", + "Clear": "Wyczyść", + "Columns": "Kolumny", + "Debugging Values": "Wartości debugowania", + "Deselect All": "Odznacz wszystko", + "Done Reordering": "Done Reordering", + "Filters": "Filtry", + "No": "Nie", + "No items found. Try to broaden your search.": "Brak rezultatów do wyświetlenia.", + "of": "z", + "Remove filter option": "Usuń opcję filtra", + "Remove sort option": "Usuń opcję sortowania", + "Reorder": "Zmień kolejność", + "results": "wyniki", + "row": "wiersz", + "rows": "wiersze", + "rows, do you want to select all": "czy chcesz zaznaczyć wszystkie wiersze", + "Search": "Szukaj", + "Select All": "Zaznacz wszystko", + "Select All On Page": "Zaznacz wszystko na stronie", + "Showing": "Pokazywanie", + "to": "do", + "Yes": "Tak", + "You are currently selecting all": "Aktualnie masz wszystko zaznaczone", + "You are not connected to the internet.": "Brak połączenia z internetem.", + "You have selected": "Masz wybrane" +} \ No newline at end of file