Component Box
[!NOTE]
No longer active!
After internal experimentation and discussion, we've decided to move forward with other options.
Sample
Model (server)
class Counter : ComposableModel<Int, CounterEvent>(0) {
private fun increment() {
withState {
setState(state.value + 1)
}
}
private fun decrement() {
withState {
setState(state.value - 1)
}
}
override fun on(event: CounterEvent) = when (event) {
Increment -> increment()
Decrement -> decrement()
}
}
UI Representation (server)
Static
@SerializableComponentBox
fun main() = componentBox {
tree {
lazyColumn<CounterEvent>(
verticalArrangement = Arrangement.SpaceEvenly(2.dp),
horizontalAlignment = Alignment.Start
) {
child(header)
child(count)
child(incrementButton)
child(decrementButton)
}
}
}
header = text(
text = ,
style = TextStyle(fontWeight = FontWeight.ExtraBold)
)
count = text(
text = ,
style = TextStyle(color = Color.Hex())
)
incrementButton = textButton(
text = ,
onClick = semantic { Increment }
)
decrementButton = textButton(
text = ,
onClick = semantic { Decrement }
)
Dynamic
@Composable
@ComponentBoxExport
fun main() = statefulComponentBoxGraph(init = null) {
Graph(start = CounterOnboardingFlow.value) {
componentBox(CounterLoginScreen.value, LoginScreen())
componentBox(CounterOnboardingFlow.value, OnboardingFlow())
componentBox(CounterScreen.Home.value, HomeScreen())
}
}
@Composable
fun LoginScreen() = Forest {
tree("heading", Tree { LoginHeading() })
tree("button", Tree { LoginButton() })
}
@Composable
fun OnboardingFlow() = Trail {
node(WelcomeScreen())
node(FeatureDiscoveryScreen())
node(HomeScreen())
}
Binaries (server)
./gradlew componentBoxJs
./gradlew componentBoxJson
Jetpack Compose (Android)
Activity
: () {
scope = CoroutineScope(Dispatchers.Default)
service = ComponentBoxService(scope)
componentBox = service.componentBox
render = RenderingEngine()
{
.onStart()
service.launch(MANIFEST_URL)
}
{
.onCreate(savedInstanceState)
setContent {
root = componentBox.collectAsState()
render {
root.value
}
}
}
}
Composable
@Composable
fun ComponentBoxView(componentBox: StateFlow<Component?>, render: RenderingEngine) {
val root = componentBox.collectAsState()
render {
root.value
}
}
React (web)
SwiftUI (iOS)
struct ComponentBoxView: View {
service ()
root: ?
body: {
render {
root
}
.onAppear {
service.launch(from: ) { result
result {
.success( componentBox):
.main.async {
.root componentBox.root
}
}
}
}
}
Snapshots
Snapshots are available
in Sonatype's snapshots repository.
License
Copyright (c) 2023 Dropbox, Inc.
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.
Acknowledgments