Skip to content

Add class() and addClass() methods to DropdownFilter #284

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.

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

Merged
merged 2 commits into from
Jun 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 25 additions & 0 deletions src/Filter/Widget/DropdownFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Yiisoft\Yii\DataView\Filter\Widget;

use BackedEnum;
use Yiisoft\Html\Tag\Select;

/**
Expand Down Expand Up @@ -90,6 +91,30 @@ public function attributes(array $attributes): self
return $new;
}

/**
* Add one or more CSS classes to the `Select` tag.
*
* @param BackedEnum|string|null ...$class One or many CSS classes.
*/
public function addClass(BackedEnum|string|null ...$class): self
{
$new = clone $this;
$new->select = $this->getSelect()->addClass(...$class);
return $new;
}

/**
* Replace current `Select` tag CSS classes with a new set of classes.
*
* @param BackedEnum|string|null ...$class One or many CSS classes.
*/
public function class(BackedEnum|string|null ...$class): self
{
$new = clone $this;
$new->select = $this->getSelect()->class(...$class);
return $new;
}

/**
* Renders the dropdown filter with the given context.
*
Expand Down
77 changes: 77 additions & 0 deletions tests/Filter/Widget/DropdownFilterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@

namespace Yiisoft\Yii\DataView\Tests\Filter\Widget;

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Yiisoft\Yii\DataView\Filter\Widget\Context;
use Yiisoft\Yii\DataView\Filter\Widget\DropdownFilter;
use Yiisoft\Yii\DataView\Tests\Support\IntegerEnum;
use Yiisoft\Yii\DataView\Tests\Support\StringEnum;

/**
* @covers \Yiisoft\Yii\DataView\Filter\Widget\DropdownFilter
Expand Down Expand Up @@ -88,4 +91,78 @@ public function testAttributes(): void
$this->assertStringContainsString('class="new-select"', $html);
$this->assertStringContainsString('required', $html);
}

public static function dataAddClass(): array
{
return [
['<select class="main" name="status"', []],
['<select class="main" name="status"', ['main']],
['<select class="main bold" name="status"', ['bold']],
['<select class="main italic bold" name="status"', ['italic bold']],
['<select class="main italic bold" name="status"', ['italic', 'bold']],
['<select class="main test-class-1 test-class-2" name="status"', [StringEnum::TEST_CLASS_1, StringEnum::TEST_CLASS_2]],
[
'<select class="main test-class-1 test-class-2" name="status"',
[IntegerEnum::A, StringEnum::TEST_CLASS_1, IntegerEnum::B, StringEnum::TEST_CLASS_2],
],
];
}

#[DataProvider('dataAddClass')]
public function testAddClass(string $expected, array $class): void
{
$context = new Context('status', null, 'filter-form');
$html = DropdownFilter::widget()
->addClass('main')
->addClass(...$class)
->renderFilter($context);
$this->assertStringContainsString($expected, $html);
}

public static function dataNewClass(): array
{
return [
['<select name="status"', null],
['<select class name="status"', ''],
['<select class="red" name="status"', 'red'],
];
}

#[DataProvider('dataNewClass')]
public function testNewClass(string $expected, ?string $class): void
{
$context = new Context('status', null, 'filter-form');
$html = DropdownFilter::widget()
->addClass($class)
->renderFilter($context);
$this->assertStringContainsString($expected, $html);
}

public static function dataClass(): array
{
return [
['<select name="status"', []],
['<select name="status"', [null]],
['<select class name="status"', ['']],
['<select class="main" name="status"', ['main']],
['<select class="main bold" name="status"', ['main bold']],
['<select class="main bold" name="status"', ['main', 'bold']],
['<select class="test-class-1 test-class-2" name="status"', [StringEnum::TEST_CLASS_1, StringEnum::TEST_CLASS_2]],
[
'class="test-class-1 test-class-2" name="status"',
[IntegerEnum::A, StringEnum::TEST_CLASS_1, IntegerEnum::B, StringEnum::TEST_CLASS_2],
],
];
}

#[DataProvider('dataClass')]
public function testClass(string $expected, array $class): void
{
$context = new Context('status', null, 'filter-form');
$html = DropdownFilter::widget()
->class('red')
->class(...$class)
->renderFilter($context);
$this->assertStringContainsString($expected, $html);
}
}
12 changes: 12 additions & 0 deletions tests/Support/IntegerEnum.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Yii\DataView\Tests\Support;

enum IntegerEnum: int
{
case A = 1;
case B = 2;
case C = 3;
}
11 changes: 11 additions & 0 deletions tests/Support/StringEnum.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Yii\DataView\Tests\Support;

enum StringEnum: string
{
case TEST_CLASS_1 = 'test-class-1';
case TEST_CLASS_2 = 'test-class-2';
}
Loading