Skip to content

Update README.md #29

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.

Sign up for GitHub

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

Open
mikelibg wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c059f74
Update README.md
mikelibg Oct 30, 2024
5f5f5c4
Update README.md
mikelibg Jan 12, 2025
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
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ from streamlit_flow import streamlit_flow
from streamlit_flow.elements import StreamlitFlowNode, StreamlitFlowEdge
from streamlit_flow.state import StreamlitFlowState

nodes = [...]
edges = [...]
nodes = []
edges = []
state = StreamlitFlowState(nodes, edges)

streamlit_flow('flow', state)
Expand All @@ -47,26 +47,28 @@ The benefits we get from this are significant, as the `StreamlitFlowState` class

**Example**
```python
import streamlit as st

from streamlit_flow import streamlit_flow
from streamlit_flow.elements import StreamlitFlowNode, StreamlitFlowEdge
from streamlit_flow.state import StreamlitFlowState
from uuid import uuid4

# Initialize the state if it doesn't exist
if 'flow_state' not in st.session_state:
nodes = [...]
edges = [...]
nodes = []
edges = []
st.session_state.flow_state = StreamlitFlowState(nodes, edges)

# Use any operation that alters the state, for example add node, and then rerun
if st.button("Add node"):
new_node = StreamlitFlowNode(key=str(f"st-flow-node_{uuid4()}"),
pos=(0, 0),
data={'content': f'Node {len(st.session_state.curr_state.nodes) + 1}'},
node_type='default',
source_position='right',
target_position='left')
st.session_state.curr_state.nodes.append(new_node)
new_node = StreamlitFlowNode(id=str(f"st-flow-node_{uuid4()}"),
pos=(0, 0),
data={'content': f'Node {len(st.session_state.flow_state.nodes) + 1}'},
node_type='default',
source_position='right',
target_position='left')
st.session_state.flow_state.nodes.append(new_node)
st.rerun()

# Use the state as the argument, as well as to store the return value
Expand Down