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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(CustomProvider): add PREVIEW_components prop #2493

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat(CustomProvider): add PREVIEW_components prop #2493

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e72ebbf
feat(CustomProvider): add PREVIEW_components prop
SevenOutman May 19, 2022
7387761
feat(CustomProvider): override Button defaultProps
SevenOutman May 20, 2022
b289091
Merge branch 'main' into feature/CustomProvider-component-defaultProps
SevenOutman Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Prev Previous commit
Next Next commit
feat(CustomProvider): override Button defaultProps
  • Loading branch information
@SevenOutman
SevenOutman committed May 20, 2022
commit 73877613baa388e1f49f85e8ef92975e94f4fb4d
3 changes: 2 additions & 1 deletion src/Button/Button.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import SafeAnchor from '../SafeAnchor';
import Ripple from '../Ripple';
import { isOneOf, useClassNames } from '../utils';
import { TypeAttributes, WithAsProps, RsRefForwardingComponent } from '../@types/common';
import { useProps } from '../CustomProvider/useProps';

export interface ButtonProps extends WithAsProps, React.HTMLAttributes<HTMLElement> {
/** A button can have different appearances. */
Expand Down Expand Up @@ -58,7 +59,7 @@ const Button: RsRefForwardingComponent<'button', ButtonProps> = React.forwardRef
size: sizeProp,
type: typeProp,
...rest
} = props;
} = useProps('Button', props);

const buttonGroup = useContext(ButtonGroupContext);

Expand Down
22 changes: 22 additions & 0 deletions src/Button/test/ButtonSpec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import ReactTestUtils from 'react-dom/test-utils';
import { getDOMNode, getInstance } from '@test/testUtils';
import { testStandardProps } from '@test/commonCases';
import Button from '../Button';
import { render } from '@testing-library/react';
import CustomProvider from '../../CustomProvider';

describe('Button', () => {
testStandardProps(<Button />);
Expand Down Expand Up @@ -104,4 +106,24 @@ describe('Button', () => {

assert.equal(instance2.getAttribute('role'), 'combobox');
});

it('Should be customizable via CustomProvider', () => {
const { getByTestId } = render(<Button data-testid="button">Ghost button</Button>, {
wrapper: ({ children }) => (
<CustomProvider
PREVIEW_components={{
Button: {
defaultProps: {
appearance: 'ghost'
}
}
}}
>
{children}
</CustomProvider>
)
});

expect(getByTestId('button')).to.have.class('rs-btn-ghost');
});
});
10 changes: 7 additions & 3 deletions src/CustomProvider/CustomProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { getClassNamePrefix, prefix } from '../utils/prefix';
import { Locale } from '../locales';
import { addClass, removeClass, canUseDOM } from '../DOMHelper';
import { MessageProps } from '../Message';
import { ButtonProps } from '../Button';

export interface CustomValue<T = Locale> {
/** Language configuration */
Expand Down Expand Up @@ -42,10 +43,13 @@ export interface CustomValue<T = Locale> {
parseDate: (dateString: string, formatString: string) => Date;
}

type ComponentOverride<P> = {
defaultProps?: Partial<P>;
};

export interface ComponentOverrides {
Message?: {
defaultProps?: Partial<MessageProps>;
};
Button?: ComponentOverride<ButtonProps>;
Message?: ComponentOverride<MessageProps>;
}

export interface CustomProviderProps<T = Locale> extends Partial<CustomValue<T>> {
Expand Down