Skip to content

Commit 9419ddc

Browse files
committed
Fix PDSplitter documentation; update release notes
1 parent eb6f533 commit 9419ddc

3 files changed

Lines changed: 40 additions & 24 deletions

File tree

PanoramicData.Blazor.Demo/Pages/PDSplitterDocumentation.razor

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,35 +17,50 @@
1717
Language="razor"
1818
DemoStyle="height: 200px;">
1919
<DemoContent>
20-
<PDSplitter Style="height: 180px;">
21-
<Panel1>
20+
<PDSplitter>
21+
<PDSplitPanel Size="1">
2222
<div class="p-2 bg-light h-100">Left Panel</div>
23-
</Panel1>
24-
<Panel2>
23+
</PDSplitPanel>
24+
<PDSplitPanel Size="1">
2525
<div class="p-2 bg-secondary text-white h-100">Right Panel</div>
26-
</Panel2>
26+
</PDSplitPanel>
2727
</PDSplitter>
2828
</DemoContent>
2929
<Description>
3030
<p>
31-
Define <code>Panel1</code> and <code>Panel2</code> content. Drag the divider to resize.
31+
Add any number of <code>PDSplitPanel</code> children. Each panel's <code>Size</code> is
32+
proportional to the sum of all siblings — two panels with <code>Size="1"</code> split evenly.
3233
</p>
3334
</Description>
3435
</DocExample>
3536
</section>
3637

3738
<section id="parameters">
38-
<h2 class="doc-section">Parameters</h2>
39+
<h2 class="doc-section">PDSplitter Parameters</h2>
3940
<table class="table table-sm doc-props-table">
4041
<thead>
4142
<tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr>
4243
</thead>
4344
<tbody>
44-
<tr><td><code>Horizontal</code></td><td><code>bool</code></td><td>true</td><td>Horizontal (left/right) or vertical (top/bottom)</td></tr>
45-
<tr><td><code>Panel1Size</code></td><td><code>string</code></td><td>"50%"</td><td>Initial size of first panel</td></tr>
46-
<tr><td><code>Panel1MinSize</code></td><td><code>string</code></td><td>"10%"</td><td>Minimum size of first panel</td></tr>
47-
<tr><td><code>Panel2MinSize</code></td><td><code>string</code></td><td>"10%"</td><td>Minimum size of second panel</td></tr>
48-
<tr><td><code>GutterSize</code></td><td><code>int</code></td><td>4</td><td>Width of the draggable divider</td></tr>
45+
<tr><td><code>Direction</code></td><td><code>SplitDirection</code></td><td><code>Horizontal</code></td><td>Split axis: <code>Horizontal</code> (left/right) or <code>Vertical</code> (top/bottom)</td></tr>
46+
<tr><td><code>ExpandToMin</code></td><td><code>bool</code></td><td><code>false</code></td><td>Expand panels to their minimum size on initial render</td></tr>
47+
<tr><td><code>GutterSize</code></td><td><code>int</code></td><td><code>10</code></td><td>Width of the draggable divider in pixels</td></tr>
48+
<tr><td><code>GutterAlign</code></td><td><code>string</code></td><td><code>"center"</code></td><td>Gutter alignment between elements</td></tr>
49+
<tr><td><code>SnapOffset</code></td><td><code>int</code></td><td><code>30</code></td><td>Distance in pixels from minimum size at which the panel snaps</td></tr>
50+
<tr><td><code>DragInterval</code></td><td><code>int</code></td><td><code>1</code></td><td>Number of pixels per drag step</td></tr>
51+
<tr><td><code>CssClass</code></td><td><code>string</code></td><td><code>""</code></td><td>Additional CSS classes for the container element</td></tr>
52+
</tbody>
53+
</table>
54+
55+
<h2 class="doc-section mt-3">PDSplitPanel Parameters</h2>
56+
<table class="table table-sm doc-props-table">
57+
<thead>
58+
<tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr>
59+
</thead>
60+
<tbody>
61+
<tr><td><code>Size</code></td><td><code>int</code></td><td><code>1</code></td><td>Proportional size relative to all sibling panels (e.g. <code>Size="1"</code> and <code>Size="2"</code> gives 33%/67%)</td></tr>
62+
<tr><td><code>MinSize</code></td><td><code>int</code></td><td><code>100</code></td><td>Minimum panel size in pixels</td></tr>
63+
<tr><td><code>CssClass</code></td><td><code>string</code></td><td><code>""</code></td><td>Additional CSS classes for the panel element</td></tr>
4964
</tbody>
5065
</table>
5166
</section>

PanoramicData.Blazor.Demo/Pages/PDSplitterDocumentation.razor.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ namespace PanoramicData.Blazor.Demo.Pages;
33
public partial class PDSplitterDocumentation
44
{
55
private const string _example1Code = """
6-
<PDSplitter Style="height: 200px;">
7-
<Panel1>
8-
<div class="p-2 bg-light h-100">
9-
Left Panel
10-
</div>
11-
</Panel1>
12-
<Panel2>
13-
<div class="p-2 bg-secondary text-white h-100">
14-
Right Panel
15-
</div>
16-
</Panel2>
6+
<PDSplitter>
7+
<PDSplitPanel Size="1">
8+
<div class="p-2 bg-light h-100">
9+
Left Panel
10+
</div>
11+
</PDSplitPanel>
12+
<PDSplitPanel Size="1">
13+
<div class="p-2 bg-secondary text-white h-100">
14+
Right Panel
15+
</div>
16+
</PDSplitPanel>
1717
</PDSplitter>
1818
""";
1919
}

PanoramicData.Blazor/PanoramicData.Blazor.csproj

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
2727
<PackageReadmeFile>README.md</PackageReadmeFile>
2828
<PackageReleaseNotes>
29-
Added "TitleFunc" function to PDColumn, so a function can be used to override Title.
29+
PDDashboard: optional name row above tabs; display-mode header with dashboard/tab name and rotation controls (pause/resume, prev/next); properties editor in settings dialog; view-mode per-session property overrides (AllowViewModePropertyEdit); fix EffectiveProperties cascade.
30+
PDSplitterDocumentation: fix example to use PDSplitPanel children; correct parameters table.
3031
</PackageReleaseNotes>
3132
</PropertyGroup>
3233

0 commit comments

Comments
 (0)