-
Notifications
You must be signed in to change notification settings - Fork 169
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: Flow components as children for ReactAdapterComponent #19434
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
08aa69e
feat: Flow components as children for ReactAdapterComponent
caalador 30a696b
Enable use of multiple containers
caalador 0771cb7
Merge branch 'main' into issues/19379-flow-components-in-react
caalador 0e0c4ce
Add JSdoc for new method
caalador 1419681
Merge branch 'main' into issues/19379-flow-components-in-react
platosha 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
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
63 changes: 63 additions & 0 deletions
63
flow-client/src/main/java/com/vaadin/client/ReactUtils.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,63 @@ | ||
/* | ||
* 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.client; | ||
|
||
import java.util.function.Supplier; | ||
|
||
import elemental.dom.Element; | ||
|
||
/** | ||
* Utils class, intended to ease working with React component related code on | ||
* the client side. | ||
* | ||
* @author Vaadin Ltd | ||
* @since 24.5. | ||
*/ | ||
public final class ReactUtils { | ||
|
||
/** | ||
* Add a callback to the react component that is called when the component | ||
* initialization is ready for binding flow. | ||
* | ||
* @param element | ||
* react component element | ||
* @param name | ||
* name of container to bind to | ||
* @param runnable | ||
* callback function runnable | ||
*/ | ||
public static native void addReadyCallback(Element element, String name, | ||
Runnable runnable) | ||
/*-{ | ||
if(element.addReadyCallback){ | ||
element.addReadyCallback(name, | ||
$entry(runnable.@java.lang.Runnable::run(*).bind(runnable)) | ||
); | ||
} | ||
}-*/; | ||
|
||
/** | ||
* Check if the react element is initialized and functional. | ||
* | ||
* @param elementLookup | ||
* react element lookup supplier | ||
* @return {@code true} if Flow binding can already be done | ||
*/ | ||
public static boolean isInitialized(Supplier<Element> elementLookup) { | ||
return elementLookup.get() != null; | ||
} | ||
} |
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
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
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
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
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
35 changes: 35 additions & 0 deletions
35
flow-tests/test-react-adapter/src/main/frontend/ReactLayout.tsx
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,35 @@ | ||
/* | ||
* 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. | ||
*/ | ||
|
||
import {ReactAdapterElement, RenderHooks} from "Frontend/generated/flow/ReactAdapter.js"; | ||
import React from "react"; | ||
|
||
class ReactLayoutElement extends ReactAdapterElement { | ||
protected render(hooks: RenderHooks): React.ReactElement | null { | ||
const content = this.useContent('content'); | ||
const second = this.useContent('second'); | ||
return <> | ||
<span>Before Flow components content</span> | ||
{content} | ||
<div></div> | ||
<span>After Flow components content</span> | ||
<div></div> | ||
{second} | ||
</>; | ||
} | ||
} | ||
|
||
customElements.define('react-layout', ReactLayoutElement); |
61 changes: 61 additions & 0 deletions
61
flow-tests/test-react-adapter/src/main/java/com/vaadin/flow/FlowInReactComponentView.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 @@ | ||
/* | ||
* 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; | ||
|
||
import com.vaadin.flow.component.Component; | ||
import com.vaadin.flow.component.html.Div; | ||
import com.vaadin.flow.component.html.H3; | ||
import com.vaadin.flow.component.html.H4; | ||
import com.vaadin.flow.component.html.NativeButton; | ||
import com.vaadin.flow.router.Route; | ||
|
||
@Route("com.vaadin.flow.FlowInReactComponentView") | ||
public class FlowInReactComponentView extends Div { | ||
|
||
public static final String ADD_MAIN = "add"; | ||
public static final String REMOVE_MAIN = "remove"; | ||
public static final String ADD_SECONDARY = "add-secondary"; | ||
public static final String REMOVE_SECONDARY = "remove-secondary"; | ||
|
||
public FlowInReactComponentView() { | ||
|
||
ReactLayout gridLayout = new ReactLayout(); | ||
add(gridLayout); | ||
|
||
NativeButton addDiv = new NativeButton("Add div", | ||
event -> gridLayout.add(new Div("Clicked button"))); | ||
addDiv.setId(ADD_MAIN); | ||
NativeButton removeDiv = new NativeButton("Remove div", | ||
event -> gridLayout.getChildren() | ||
.filter(component -> component instanceof Div) | ||
.findFirst().ifPresent(Component::removeFromParent)); | ||
removeDiv.setId(REMOVE_MAIN); | ||
|
||
gridLayout.add(new H3("Flow Admin View"), addDiv, removeDiv); | ||
|
||
NativeButton addSecondary = new NativeButton("Add div", | ||
event -> gridLayout.addSecondary(new Div("Secondary div"))); | ||
addSecondary.setId(ADD_SECONDARY); | ||
NativeButton removeSecondary = new NativeButton("Remove div", | ||
event -> gridLayout.getSecondaryChildren() | ||
.filter(component -> component instanceof Div) | ||
.findFirst().ifPresent(Component::removeFromParent)); | ||
removeSecondary.setId(REMOVE_SECONDARY); | ||
gridLayout.addSecondary(new H4("Second container"), addSecondary, | ||
removeSecondary); | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
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.
Missing JSdoc on the public method. Should this be marked as internal in JSdoc, perhaps?
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.
done