search

orefalo / svelte-splitpanes

MIT License
372 stars 17 forks source link

Take splitter size into account when sizing panes to avoid UI overflow #97

Open Picorims opened 1 month ago

Picorims commented 1 month ago

Some split panes designs have a size for the splitter (usually some kind of border of a different color clearly separating panes), and such designs are a bit tedious to implement with this library currently. It would be great that the computation of pane sizes take into account the splitter size.

It is still possible to work around this, this is one example of a solution:

.splitpanes.custom-theme {
    &.splitpanes--vertical > .splitpanes__splitter::before {
        width: 16px;
    }
    &.splitpanes--vertical > .splitpanes__splitter ~ .splitpanes__pane {
        padding-left: 16px;
    }
    &.splitpanes--horizontal > .splitpanes__splitter::before {
        height: 16px;
    }
    &.splitpanes--horizontal > .splitpanes__splitter ~ .splitpanes__pane {
        padding-top: 16px;
    }
}

but it would be great if the following was enough:

.splitpanes.custom-theme {
    &.splitpanes--vertical > .splitpanes__splitter::before {
        width: 16px;
    }
    &.splitpanes--horizontal > .splitpanes__splitter::before {
        height: 16px;
    }
}

It could also be supported by making it a SplitPanes prop, so that it is easy to take into account in the logic by using a basis of: 100 - ((panesCount - 1) splitterSize / totalSize 100) instead of 100.

Then, that value only has to be assigned to splitter children. The only caveat (or is it one?) is that it must be specified for each instance.

This would allow for something like:

<Splitpanes
    class="main-split-pane"
    theme="custom-theme"
    splitterSize={16}
>
    //...
</SplitPanes>

I do understand that it is not trivial to implement and rather niche. But I thought it would be great to bring to attention for consideration in the future. That would also fix a small bug where the splitter end sometime "jumps" 1px on and off.

orefalo commented 3 weeks ago

Hi @Picorims, apologies for my late response.

I understand it would be useful, but I do not plan to implement these features. The splitter size should be defined in CSS along with color and other properties. In other words, the size should be implicit rather than explicit (inside the code).

That said, I realize that changing the splitter style today is not straightforward; it should be a standalone component.

Perhaps with the Svelte5 port...

Picorims commented 2 weeks ago

It is ok, I understand the design choice, I just wanted to bring it to attention in the case of a revamp in the future.