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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: allow to put arrows on top #182

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Feature: allow to put arrows on top #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ export default App;
| `endShape` | `Object` | An object containing the props to configure the "end shape" of the arrow. Can be one of `arrow` (default) or `circle`. See [`ShapeType`](flow-typed/archer-types.js) for a complete list of available options.
| `startMarker` | `boolean` | Optional flag (default `false`) to also add a marker at the start of the arrow.
| `endMarker` | `boolean` | Optional flag (default `true`) to remove the marker at the end of the arrow.
| `isSvgOnTop` | `boolean` | Optional flag (default `false`) to make the svg container drawn on top.

#### Instance methods

Expand Down
23 changes: 15 additions & 8 deletions src/ArcherContainer/ArcherContainer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ const ArcherContainer = React.forwardRef<ArcherContainerHandle, ArcherContainerP
startMarker,
strokeDasharray,
style,
isSvgOnTop = false,
}: ArcherContainerProps,
archerContainerRef,
) => {
Expand Down Expand Up @@ -139,9 +140,22 @@ const ArcherContainer = React.forwardRef<ArcherContainerHandle, ArcherContainerP
[_registerTransitions, _unregisterTransitions, _registerChild, _unregisterChild],
);

const content = (
<div
style={{
height: '100%',
}}
ref={parent}
>
{newChildren}
</div>
);

return (
<ArcherContainerContextProvider value={contextValue}>
<div style={{ ...style, position: 'relative' }} className={className}>
{isSvgOnTop && content}

<svg style={_svgContainerStyle}>
<defs>
<ArrowMarkers
Expand All @@ -168,14 +182,7 @@ const ArcherContainer = React.forwardRef<ArcherContainerHandle, ArcherContainerP
/>
</svg>

<div
style={{
height: '100%',
}}
ref={parent}
>
{newChildren}
</div>
{!isSvgOnTop && content}
</div>
</ArcherContainerContextProvider>
);
Expand Down
5 changes: 5 additions & 0 deletions src/ArcherContainer/ArcherContainer.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ export type ArcherContainerProps = {
*/
noCurves?: boolean;

/**
* Set this to true if you want to draw the SVG arrows above your elements
*/
isSvgOnTop?: boolean;

children?: React.ReactNode | FunctionChild;
};

Expand Down