Skip to content
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.

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

how can I set the default size in pixels instead of percentage? #141

Closed
AshtonScalise opened this issue May 9, 2023 · 3 comments
Closed

Comments

@AshtonScalise
Copy link

AshtonScalise commented May 9, 2023

is this supported or do I need to calc the percentage myself?

nvm I just do myself

if anyone wondering it is

({pixel size you want} / window.innerWidth) * 100

@bvaughn
Copy link
Owner

bvaughn commented May 9, 2023

A more verbose answer, copied from #114:


Here is a way you could basically implement this in your application code:

https://codesandbox.io/s/react-resizable-panels-forked-m5qf69?file=/src/App.js

  const MIN_SIZE_IN_PIXELS = 100;

  const [minSize, setMinSize] = useState(10);

  useLayoutEffect(() => {
    const panelGroup = document.querySelector('[data-panel-group-id="group"]');
    const resizeHandles = document.querySelectorAll(
      "[data-panel-resize-handle-id]"
    );
    const observer = new ResizeObserver(() => {
      let height = panelGroup.offsetHeight;

      resizeHandles.forEach((resizeHandle) => {
        height -= resizeHandle.offsetHeight;
      });

      // Minimum size in pixels is a percentage of the PanelGroup's height,
      // less the (fixed) height of the resize handles.
      setMinSize((MIN_SIZE_IN_PIXELS / height) * 100);
    });
    observer.observe(panelGroup);
    resizeHandles.forEach((resizeHandle) => {
      observer.observe(resizeHandle);
    });

    return () => {
      observer.disconnect();
    };
  }, []);

Here my reasoning for not wanting to add it to the NPM package directly:

I think the problem with this is similar to the problem with external width/height props– either can change without PanelGroup/Panel re-rendering or being aware. (Example: an external stylesheet could define this style.)

So handling it fully would go from being something triggered only by pointer events to something that could be triggered by a lot of external things.

I don't think I want to try to support that level of complexity 😄

@cedeber
Copy link

cedeber commented Jun 8, 2023

Regarding that, why not offering something like that:

<PanelGroup>
  {(w, h) => (
    <Panel defaultSize={w(300)}>Hello, Panel</Panel>
  }
</PanelGroup>

w and h converting pixels to percentages from the Resize Observer width and height?

In this case it's probably easy to detect if the children is a function or not. And if not, just behave as normal.

onResize could offer the same with onResize(perc, w, h) { .. }


I am also wondering if PanelGroup and other components should not offer a "real" ref to have access to a dom node instead of the api, in order to attach a ResizeObserver. Then you can have apiRef to give access to the imperative APIs. (or domRef in addition, as long as it works it's ok either ways 😅)

@bvaughn
Copy link
Owner

bvaughn commented Aug 6, 2023

I think I have a possible solution for the pixel-based constraints; see #176


❤️ → ☕ givebrian.coffee

bvaughn added a commit that referenced this issue Aug 13, 2023
Relates to issues #46, #47, #51, #78, #114, #128, #141

This PR adds a new prop (`units`) to `PanelGroup`. This prop defaults to
"percentage" but can be set to "pixels" for static, pixel based layout
constraints.

This can be used to add enable pixel-based min/max and default size
values, e.g.:
```tsx
 <PanelGroup direction="horizontal" units="pixels">
   {/* Will be constrained to 100-200 pixels (assuming group is large enough to permit this) */}
   <Panel minSize={100} maxSize={200} />
   <PanelResizeHandle />
   <Panel />
   <PanelResizeHandle />
   <Panel />
 </PanelGroup>
```

Imperative API methods are also able to work with either pixels or
percentages now. They default to whatever units the group has been
configured to use, but can be overridden with an additional, optional
parameter, e.g.
```ts
panelRef.resize(100, "pixels");
panelGroupRef.setLayout([25, 50, 25], "percentages");

// Works for getters too, e.g.
const percentage = panelRef.getSize("percentages");
const pixels = panelRef.getSize("pixels");

const layout = panelGroupRef.getLayout("pixels");
```

See the docs for more:
[.../examples/pixel-based-layouts](https://react-resizable-panels-git-panelgroup-layout-val-2424f0-bvaughn.vercel.app/examples/pixel-based-layouts)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants