-
Notifications
You must be signed in to change notification settings - Fork 66
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
feat: grid empty state content #6321
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
32 changes: 32 additions & 0 deletions
32
...integration-tests/src/main/java/com/vaadin/flow/component/grid/it/GridEmptyStatePage.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
package com.vaadin.flow.component.grid.it; | ||
|
||
import com.vaadin.flow.component.button.Button; | ||
import com.vaadin.flow.component.grid.Grid; | ||
import com.vaadin.flow.component.html.Div; | ||
import com.vaadin.flow.data.bean.Person; | ||
import com.vaadin.flow.router.Route; | ||
|
||
@Route("vaadin-grid/empty-state") | ||
public class GridEmptyStatePage extends Div { | ||
public GridEmptyStatePage() { | ||
var grid = new Grid<>(Person.class); | ||
add(grid); | ||
|
||
// Button to set the empty state content | ||
var setEmptyStateContentButton = new Button("Set empty state content", | ||
event -> grid.setEmptyStateText("Custom empty state content")); | ||
setEmptyStateContentButton.setId("set-empty-state-content"); | ||
|
||
// Button to set the grid items | ||
var setItemsButton = new Button("Set items", event -> grid | ||
.setItems(new Person("John", 20), new Person("Jane", 30))); | ||
setItemsButton.setId("set-items"); | ||
|
||
// Button to clear the grid items | ||
var clearItemsButton = new Button("Clear items", | ||
event -> grid.setItems()); | ||
clearItemsButton.setId("clear-items"); | ||
|
||
add(setEmptyStateContentButton, setItemsButton, clearItemsButton); | ||
} | ||
} |
61 changes: 61 additions & 0 deletions
61
...w-integration-tests/src/test/java/com/vaadin/flow/component/grid/it/GridEmptyStateIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
package com.vaadin.flow.component.grid.it; | ||
|
||
import org.junit.Assert; | ||
import org.junit.Before; | ||
import org.junit.Test; | ||
import org.openqa.selenium.NoSuchElementException; | ||
|
||
import com.vaadin.flow.component.button.testbench.ButtonElement; | ||
import com.vaadin.flow.component.grid.testbench.GridElement; | ||
import com.vaadin.flow.testutil.TestPath; | ||
import com.vaadin.tests.AbstractComponentIT; | ||
|
||
@TestPath("vaadin-grid/empty-state") | ||
public class GridEmptyStateIT extends AbstractComponentIT { | ||
private GridElement grid; | ||
private ButtonElement setEmptyStateContentButton; | ||
private ButtonElement clearItemsButton; | ||
private ButtonElement setItemsButton; | ||
|
||
@Before | ||
public void init() { | ||
open(); | ||
grid = $(GridElement.class).first(); | ||
setEmptyStateContentButton = $(ButtonElement.class) | ||
.id("set-empty-state-content"); | ||
clearItemsButton = $(ButtonElement.class).id("clear-items"); | ||
setItemsButton = $(ButtonElement.class).id("set-items"); | ||
} | ||
|
||
@Test | ||
public void getEmptyStateContent_throws() { | ||
Assert.assertThrows("No empty state content was found", | ||
NoSuchElementException.class, | ||
() -> grid.getEmptyStateContent()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateContent_emptyStateContentDisplayed() { | ||
setEmptyStateContentButton.click(); | ||
var content = grid.getEmptyStateContent(); | ||
Assert.assertEquals("Custom empty state content", content.getText()); | ||
Assert.assertTrue(content.isDisplayed()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateContent_setItems_emptyStateContentNotDisplayed() { | ||
setEmptyStateContentButton.click(); | ||
setItemsButton.click(); | ||
var content = grid.getEmptyStateContent(); | ||
Assert.assertFalse(content.isDisplayed()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateContent_setItems_clearItems_emptyStateContentDisplayed() { | ||
setEmptyStateContentButton.click(); | ||
setItemsButton.click(); | ||
clearItemsButton.click(); | ||
var content = grid.getEmptyStateContent(); | ||
Assert.assertTrue(content.isDisplayed()); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
138 changes: 138 additions & 0 deletions
138
...ent/vaadin-grid-flow/src/test/java/com/vaadin/flow/component/grid/GridEmptyStateTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
/* | ||
* Copyright 2000-2024 Vaadin Ltd. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
* use this file except in compliance with the License. You may obtain a copy of | ||
* the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
* License for the specific language governing permissions and limitations under | ||
* the License. | ||
*/ | ||
|
||
package com.vaadin.flow.component.grid; | ||
|
||
import java.util.Optional; | ||
|
||
import org.junit.Assert; | ||
import org.junit.Before; | ||
import org.junit.Test; | ||
|
||
import com.vaadin.flow.component.html.Div; | ||
import com.vaadin.flow.dom.Element; | ||
|
||
public class GridEmptyStateTest { | ||
|
||
private Grid<String> grid; | ||
|
||
@Before | ||
public void setup() { | ||
grid = new Grid<>(); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateComponent_hasEmptyStateComponent() { | ||
var content = new Div(); | ||
grid.setEmptyStateComponent(content); | ||
Assert.assertEquals(content.getElement(), getEmptyStateElement()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateText_hasEmptyStateText() { | ||
var content = "empty"; | ||
grid.setEmptyStateText(content); | ||
var emptyStateElement = getEmptyStateElement(); | ||
Assert.assertEquals(content, emptyStateElement.getText()); | ||
Assert.assertEquals("span", emptyStateElement.getTag()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateComponent_overridesEmptyStateText() { | ||
grid.setEmptyStateText("empty"); | ||
var content = new Div(); | ||
grid.setEmptyStateComponent(content); | ||
Assert.assertEquals(content.getElement(), getEmptyStateElement()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateText_overridesEmptyStateComponent() { | ||
var content = "empty"; | ||
grid.setEmptyStateComponent(new Div()); | ||
grid.setEmptyStateText(content); | ||
var emptyStateElement = getEmptyStateElement(); | ||
Assert.assertEquals(content, emptyStateElement.getText()); | ||
Assert.assertEquals("span", emptyStateElement.getTag()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateComponentNull_noEmptyStateComponent() { | ||
grid.setEmptyStateText("empty"); | ||
grid.setEmptyStateComponent(null); | ||
Assert.assertTrue(getEmptyStateElementOptional().isEmpty()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateTextNull_noEmptyStateComponent() { | ||
grid.setEmptyStateText("empty"); | ||
grid.setEmptyStateText(null); | ||
Assert.assertTrue(getEmptyStateElementOptional().isEmpty()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateComponent_getEmptyStateComponent() { | ||
var content = new Div(); | ||
grid.setEmptyStateComponent(content); | ||
Assert.assertEquals(content, grid.getEmptyStateComponent()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateText_getEmptyStateText() { | ||
var content = "empty"; | ||
grid.setEmptyStateText(content); | ||
Assert.assertEquals(content, grid.getEmptyStateText()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateComponent_setEmptyStateText_getEmptyStateComponent() { | ||
grid.setEmptyStateComponent(new Div()); | ||
grid.setEmptyStateText("empty"); | ||
Assert.assertNull(grid.getEmptyStateComponent()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateText_setEmptyStateComponent_getEmptyStateText() { | ||
grid.setEmptyStateText("empty"); | ||
grid.setEmptyStateComponent(new Div()); | ||
Assert.assertNull(grid.getEmptyStateText()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateComponent_setEmptyStateTextNull_getEmptyStateComponent() { | ||
grid.setEmptyStateComponent(new Div()); | ||
grid.setEmptyStateText(null); | ||
Assert.assertNull(grid.getEmptyStateComponent()); | ||
Assert.assertNull(grid.getEmptyStateText()); | ||
} | ||
|
||
@Test | ||
public void setEmptyStateText_setEmptyStateComponentNull_getEmptyStateText() { | ||
grid.setEmptyStateText("empty"); | ||
grid.setEmptyStateComponent(null); | ||
Assert.assertNull(grid.getEmptyStateComponent()); | ||
Assert.assertNull(grid.getEmptyStateText()); | ||
} | ||
|
||
private Element getEmptyStateElement() { | ||
return getEmptyStateElementOptional().orElse(null); | ||
} | ||
|
||
private Optional<Element> getEmptyStateElementOptional() { | ||
return grid.getElement().getChildren().filter( | ||
child -> child.getAttribute("slot").equals("empty-state")) | ||
.findFirst(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the Javadoc mention that calling one setter will remove whatever has been defined by the other setter? I think that, generally, a setter is understood as an overriding task, but since in this case, we have two different setters around the same feature, we could make it clearer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, updated the documentation