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

COM-287: Refactor theming of LinkControls #1651

56 changes: 35 additions & 21 deletions packages/admin/admin-rte/src/core/Controls/LinkControls.tsx
Original file line number Diff line number Diff line change
@@ -1,44 +1,54 @@
import { ButtonGroup, ComponentsOverrides, Theme } from "@mui/material";
import { createStyles, WithStyles, withStyles } from "@mui/styles";
import { ThemedComponentBaseProps } from "@comet/admin";
import { ButtonGroup, ComponentsOverrides, css, styled, Theme, useThemeProps } from "@mui/material";
import * as React from "react";

import LinkToolbarButton from "../extension/Link/ToolbarButton";
import LinksRemoveToolbarButton from "../extension/LinksRemove/ToolbarButton";
import { IControlProps } from "../types";

function LinkControls(p: IControlProps & WithStyles<typeof styles>) {
export type RteLinkControlsProps = ThemedComponentBaseProps<{ root: typeof ButtonGroup; item: "div" }>;

function StyledLinkControls(p: IControlProps, inProps: RteLinkControlsProps) {
const {
options: { supports: supportedThings, overwriteLinkButton, overwriteLinksRemoveButton },
classes,
} = p;

const { slotProps, ...restProps } = useThemeProps({ props: inProps, name: "CometAdminRteLinkControls" });

const LinkButtonComponent = overwriteLinkButton ? overwriteLinkButton : LinkToolbarButton;
const LinksRemoveButtonComponent = overwriteLinksRemoveButton ? overwriteLinksRemoveButton : LinksRemoveToolbarButton;

return (
<ButtonGroup classes={{ root: classes.root }}>
<div className={classes.item}>{supportedThings.includes("link") && <LinkButtonComponent {...p} />}</div>
<div className={classes.item}>{supportedThings.includes("links-remove") && <LinksRemoveButtonComponent {...p} />}</div>
</ButtonGroup>
<Root {...slotProps?.root} {...restProps}>
<Item {...slotProps?.item}>{supportedThings.includes("link") && <LinkButtonComponent {...p} />}</Item>
<Item {...slotProps?.item}>{supportedThings.includes("links-remove") && <LinksRemoveButtonComponent {...p} />}</Item>
</Root>
);
}

export type RteLinkControlsClassKey = "root" | "item";

const styles = () => {
return createStyles<RteLinkControlsClassKey, IControlProps>({
root: {},
item: {
marginRight: 1,
minWidth: 0,
"&:last-child": {
marginRight: 0,
},
},
});
};
const Root = styled(ButtonGroup, {
name: "CometAdminRteLinkControls",
slot: "root",
overridesResolver(_, styles) {
return [styles.root];
},
})();

const StyledLinkControls = withStyles(styles, { name: "CometAdminRteLinkControls" })(LinkControls);
const Item = styled("div", {
name: "CometAdminRteLinkControls",
slot: "item",
overridesResolver(_, styles) {
return [styles.item];
},
})(css`
margin-right: 1px;
min-width: 0;
&:last-child {
margin-right: 0;
}
`);

// If there are no link-actions, this must return null not just an empty component, to prevent an empty item from being rendered in Toolbar
export default (p: IControlProps) => {
Expand All @@ -52,6 +62,10 @@ export default (p: IControlProps) => {
};

declare module "@mui/material/styles" {
interface ComponentsPropsList {
CometAdminMyComponent: RteLinkControlsProps;
}

interface ComponentNameToClassKey {
CometAdminRteLinkControls: RteLinkControlsClassKey;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/admin/admin-rte/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ export { BlockElement, RteBlockElementClassKey, RteBlockElementProps } from "./c
export { default as BlockTypesControls, RteBlockTypeControlsClassKey } from "./core/Controls/BlockTypesControls";
export { default as ControlButton, IProps as IControlButtonProps, RteControlButtonClassKey } from "./core/Controls/ControlButton";
export { FeaturesButtonGroup, RteFeaturesButtonGroupClassKey } from "./core/Controls/FeaturesButtonGroup";
export { default as LinkControls, RteLinkControlsClassKey } from "./core/Controls/LinkControls";
export { default as LinkControls, RteLinkControlsClassKey, RteLinkControlsProps } from "./core/Controls/LinkControls";
export { Toolbar } from "./core/Controls/Toolbar/Toolbar";
export { RteToolbarClassKey } from "./core/Controls/Toolbar/Toolbar.styles";
export { default as LinkDecorator } from "./core/extension/Link/Decorator";
Expand Down
Loading