forked from mui/material-ui
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Stack][joy] Add new component (mui#33800)
- Loading branch information
Showing
6 changed files
with
146 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
import * as React from 'react'; | ||
import { describeConformance, createRenderer } from 'test/utils'; | ||
import { ThemeProvider } from '@mui/joy/styles'; | ||
import Stack, { stackClasses as classes } from '@mui/joy/Stack'; | ||
|
||
describe('Joy <Stack />', () => { | ||
const { render } = createRenderer(); | ||
|
||
const defaultProps = { | ||
children: <div />, | ||
}; | ||
|
||
describeConformance(<Stack {...defaultProps} />, () => ({ | ||
classes, | ||
inheritComponent: 'div', | ||
render, | ||
ThemeProvider, | ||
refInstanceof: window.HTMLElement, | ||
muiName: 'JoyStack', | ||
skip: ['componentsProp', 'rootClass'], | ||
testVariantProps: { direction: 'row' }, | ||
})); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
import { createStack } from '@mui/system'; | ||
import PropTypes from 'prop-types'; | ||
import { OverridableComponent } from '@mui/types'; | ||
import { StackTypeMap } from './StackProps'; | ||
import styled from '../styles/styled'; | ||
import { useThemeProps } from '../styles'; | ||
|
||
const Stack = createStack({ | ||
componentName: 'JoyStack', | ||
createStyledComponent: styled('div', { | ||
name: 'JoyStack', | ||
slot: 'Root', | ||
overridesResolver: (props, styles) => styles.root, | ||
}), | ||
useThemeProps: (inProps) => useThemeProps({ props: inProps, name: 'JoyStack' }), | ||
}) as OverridableComponent<StackTypeMap>; | ||
|
||
Stack.propTypes /* remove-proptypes */ = { | ||
// ----------------------------- Warning -------------------------------- | ||
// | These PropTypes are generated from the TypeScript type definitions | | ||
// | To update them edit TypeScript types and run "yarn proptypes" | | ||
// ---------------------------------------------------------------------- | ||
/** | ||
* The content of the component. | ||
*/ | ||
children: PropTypes.node, | ||
/** | ||
* Defines the `flex-direction` style property. | ||
* It is applied for all screen sizes. | ||
* @default 'column' | ||
*/ | ||
direction: PropTypes.oneOfType([ | ||
PropTypes.oneOf(['column-reverse', 'column', 'row-reverse', 'row']), | ||
PropTypes.arrayOf(PropTypes.oneOf(['column-reverse', 'column', 'row-reverse', 'row'])), | ||
PropTypes.object, | ||
]), | ||
/** | ||
* Add an element between each child. | ||
*/ | ||
divider: PropTypes.node, | ||
/** | ||
* Defines the space between immediate children. | ||
* @default 0 | ||
*/ | ||
spacing: PropTypes.oneOfType([ | ||
PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.number, PropTypes.string])), | ||
PropTypes.number, | ||
PropTypes.object, | ||
PropTypes.string, | ||
]), | ||
/** | ||
* The system prop, which allows defining system overrides as well as additional CSS styles. | ||
*/ | ||
sx: PropTypes.oneOfType([ | ||
PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), | ||
PropTypes.func, | ||
PropTypes.object, | ||
]), | ||
} as any; | ||
|
||
export default Stack; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
import * as React from 'react'; | ||
import { OverrideProps } from '@mui/types'; | ||
import { ResponsiveStyleValue } from '@mui/system'; | ||
import { SxProps } from '../styles/types'; | ||
|
||
export type StackSlot = 'root'; | ||
|
||
export interface StackTypeMap<P = {}, D extends React.ElementType = 'div'> { | ||
props: P & { | ||
/** | ||
* The content of the component. | ||
*/ | ||
children?: React.ReactNode; | ||
/** | ||
* Defines the `flex-direction` style property. | ||
* It is applied for all screen sizes. | ||
* @default 'column' | ||
*/ | ||
direction?: ResponsiveStyleValue<'row' | 'row-reverse' | 'column' | 'column-reverse'>; | ||
/** | ||
* Defines the space between immediate children. | ||
* @default 0 | ||
*/ | ||
spacing?: ResponsiveStyleValue<number | string>; | ||
/** | ||
* Add an element between each child. | ||
*/ | ||
divider?: React.ReactNode; | ||
/** | ||
* The system prop, which allows defining system overrides as well as additional CSS styles. | ||
*/ | ||
sx?: SxProps; | ||
}; | ||
defaultComponent: D; | ||
} | ||
|
||
export type StackProps< | ||
D extends React.ElementType = StackTypeMap['defaultComponent'], | ||
P = {}, | ||
> = OverrideProps<StackTypeMap<P, D>, D>; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
export { default } from './Stack'; | ||
export * from './StackProps'; | ||
|
||
export { default as stackClasses } from './stackClasses'; | ||
export * from './stackClasses'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import { StackClasses } from '@mui/system'; | ||
import { generateUtilityClass, generateUtilityClasses } from '../className'; | ||
|
||
export type { StackClassKey } from '@mui/system'; | ||
export type { StackClasses }; | ||
|
||
export function getStackUtilityClass(slot: string): string { | ||
return generateUtilityClass('JoyStack', slot); | ||
} | ||
|
||
const stackClasses: StackClasses = generateUtilityClasses('JoyStack', ['root']); | ||
|
||
export default stackClasses; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters