Examples¶
Small, self-contained snippets and full apps that show PythonNative's
component model and patterns. Each example is also runnable inside a
project scaffolded with pn init.
Featured examples¶
| Page | What it covers |
|---|---|
| Hello world | The smallest possible app and how it boots. |
| Counter | use_state, event handlers, and basic styling. |
| Forms | TextInput, controlled inputs, validation, submit. |
| Lists | FlatList, keyed children, dynamic rendering. |
| Navigation | Stack, tab, and drawer navigators side-by-side. |
| Collapsing header & bottom sheet | Scroll-driven animation, Animated.event, gestures, and stacking. |
Complete apps¶
The repository also includes runnable projects with their own setup instructions:
- Hello world: a small application for trying the development workflow.
- Inbox: an offline app with variable-height lists, shared state, search, editing, persistence, native navigation, and a generated native extension.
- Feature catalog: component and API demonstrations used by the mobile E2E suite.
Working from a project¶
pn init my-app
cd my-app
# Edit app/main.py and paste any of the snippets below.
pn preview # dev server + browser preview with Fast Refresh
pn run android # or: pn run ios
The app/main.py that pn init writes already returns a small
counter; replace it with one of the snippets to try a different
example. The quickest way to iterate is
pn preview, which renders the app in a
browser tab and Fast Refreshes on every save; pn run puts it on a
device or simulator connected to the same dev server.
Snippets¶
Reusable components¶
Compose small components and pass them as children:
import pythonnative as pn
@pn.component
def LabeledInput(label: str = "", placeholder: str = ""):
return pn.Column(
pn.Text(label, style={"font_size": 14, "bold": True}),
pn.TextInput(placeholder=placeholder),
style={"spacing": 4},
)
@pn.component
def SignUp():
return pn.ScrollView(
pn.Column(
pn.Text("Sign up", style={"font_size": 24, "bold": True}),
LabeledInput(label="Name", placeholder="Enter your name"),
LabeledInput(label="Email", placeholder="you@example.com"),
pn.Button("Submit", on_press=lambda: print("submitted")),
style={"spacing": 12, "padding": 16},
)
)
Theming¶
BRAND = pn.DEFAULT_LIGHT_THEME.replace(primary_color="#0a84ff")
@pn.component
def Header():
theme = pn.use_theme() # follows light/dark mode unless a provider pins one
return pn.Text(
"Hello",
style={"color": theme.primary_color, "font_size": theme.font_size_title, "bold": True},
)
@pn.component
def App():
return pn.ThemeContext.Provider(
BRAND,
pn.Column(Header(), style={"padding": 16}),
)
Wrapping with an error boundary¶
@pn.component
def Risky():
raise RuntimeError("oops")
@pn.component
def Safe():
return pn.ErrorBoundary(
Risky(),
fallback=lambda exc: pn.Text(f"Failed: {exc}"),
)
Flex distribution and absolute positioning¶
@pn.component
def LayoutShowcase():
return pn.Column(
pn.Row(
pn.View(style={"flex": 1, "height": 60, "background_color": "#FAD"}),
pn.View(style={"flex": 2, "height": 60, "background_color": "#ADF"}),
pn.View(style={"flex": 1, "height": 60, "background_color": "#DFA"}),
style={"spacing": 8, "align_items": "stretch"},
),
pn.View(
pn.View(style={"position": "absolute", "top": 8, "left": 8,
"width": 32, "height": 32,
"background_color": "#F00"}),
pn.View(style={"position": "absolute", "bottom": 8, "right": 8,
"width": 32, "height": 32,
"background_color": "#0A0"}),
style={"width": 200, "height": 120, "background_color": "#EEE"},
),
style={"spacing": 12, "padding": 16},
)
See Layout engine for the full set of supported flexbox features.
Next steps¶
- Walk through the smallest possible app: Hello world.
- Learn the bigger picture: Mental model.
- See the live API: Package overview.