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

Add extractTypeDescribedValue to PropsTable #38

Merged
merged 2 commits into from
Jun 15, 2018
Merged

Add extractTypeDescribedValue to PropsTable #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e34b2f5
fix(docz): add extractTypeDescribedValue to PropsTable
renatorib Jun 14, 2018
417c9bb
fix(docz): show PropsTable shape in brackets
renatorib Jun 14, 2018
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
47 changes: 41 additions & 6 deletions packages/docz/src/components/PropsTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,18 @@ export interface FlowTypeArgs {
}
}

export interface PropType {
name: string
value?: any
}

export interface Prop {
required: boolean
description?: string
type: {
name: string
value?: EnumValue[]
}
type: PropType
defaultValue?: {
value: string
computed: boolean
}
flowType?: {
elements: FlowTypeElement[]
Expand Down Expand Up @@ -61,7 +64,39 @@ export type TooltipComponent = React.ComponentType<{
children: React.ReactNode
}>

const getValue = (value: string) => value.replace(/\'/g, '')
const extractTypeDescribedValue = (type: PropType): string => {
const { name, value } = type

// instanceOf, computed shape, uknown enum
if (typeof value === 'string') {
return value
}

// oneOf, oneOfType
if (Array.isArray(value)) {
return value.map(valueType => {
if (valueType.name === 'custom') {
return `custom(${valueType.raw})`
}

return valueType.name || valueType.value
}).join(' | ')
}

// arrayOf, objectOf
if (typeof value === 'object' && name !== 'shape') {
return value.name
}

// shape
if (typeof value === 'object' && name === 'shape') {
// show only keys due to a recursive limitation
return `{ ${Object.keys(value).join(', ')} }`
}

// untreated
return ''
}

const getPropType = (prop: Prop, Tooltip?: TooltipComponent) => {
const name = prop.flowType ? prop.flowType.name : prop.type.name
Expand All @@ -75,7 +110,7 @@ const getPropType = (prop: Prop, Tooltip?: TooltipComponent) => {
return prop.flowType ? (
<Tooltip text={prop.flowType.raw}>{name}</Tooltip>
) : (
<Tooltip text={value && value.map(val => getValue(val.value)).join(' | ')}>
<Tooltip text={extractTypeDescribedValue(prop.type)}>
{name}
</Tooltip>
)
Expand Down