Commit ⋅ vue-styleguidist/vue-styleguidist

import PropTypes from 'prop-types'
import Markdown from 'rsg-components/Markdown'
import Styled from 'rsg-components/Styled'
import { DOCS_COMPONENTS } from '../../../scripts/consts'
import consts from '../../../scripts/consts'

const styles = ({ space, maxWidth }) => ({
	root: {

@@ -29,7 +29,7 @@

      components: 'src/components/**/*.vue'
    };

Read more in the [locating components guide](${DOCS_COMPONENTS}).
Read more in the [locating components guide](${consts.DOCS_COMPONENTS}).
				`}
			/>
		</div>

@@ -41,7 +41,7 @@

	children: PropTypes.node,
	toolbar: PropTypes.node,
	id: PropTypes.string.isRequired,
	href: PropTypes.string.isRequired,
	href: PropTypes.string,
	depth: PropTypes.number.isRequired,
	deprecated: PropTypes.bool,
	parentName: PropTypes.string,

@@ -69,9 +69,13 @@

	return (
		<div className={classes.wrapper}>
			<Heading level={headingLevel} id={id}>
				<a href={href} className={sectionNameClasses}>
					{children}
				</a>
				{href ? (
					<a href={href} className={sectionNameClasses}>
						{children}
					</a>
				) : (
					<span className={sectionNameClasses}>{children}</span>
				)}
				{parentName && parentHref && (
					<a href={parentHref} className={classes.parentName}>
						{parentName}

@@ -4,7 +4,7 @@

import { getDefaultExample } from 'vue-inbrowser-compiler-utils'
import Styled from 'rsg-components/Styled'
import Markdown from 'rsg-components/Markdown'
import { DOCS_DOCUMENTING } from '../../../scripts/consts'
import consts from '../../../scripts/consts'
import { DocumentedComponentContext } from '../VsgReactComponent/ReactComponent'

const styles = ({ fontFamily, fontSize, color }) => ({

@@ -93,7 +93,7 @@


You may need to **restart** the style guide server after adding an example file.

Read more in the [documenting components guide](${DOCS_DOCUMENTING}).
Read more in the [documenting components guide](${consts.DOCS_DOCUMENTING}).
					`}
				/>
			)

@@ -2,8 +2,9 @@

import * as Rsg from 'react-styleguidist'
import PropTypes from 'prop-types'
import Styled, { JssInjectedProps } from 'rsg-components/Styled'
import Argument, { ArgumentProps } from 'rsg-components/Argument'
import Argument from 'rsg-components/Argument'
import Heading from 'rsg-components/Heading'
import { ArgumentProps } from '../Argument/ArgumentRenderer'

export const styles = ({ space }: Rsg.Theme) => ({
	root: {

@@ -49,7 +50,7 @@

		PropTypes.shape({
			name: PropTypes.string.isRequired,
			type: PropTypes.object,
			description: PropTypes.string.isRequired
			description: PropTypes.string
		}).isRequired
	).isRequired,
	heading: PropTypes.bool

@@ -6,7 +6,7 @@

import cx from 'classnames'
import Ribbon from 'rsg-components/Ribbon'
import Version from 'rsg-components/Version'
import { HOMEPAGE } from '../../../scripts/consts'
import consts from '../../../scripts/consts'

const styles = ({ color, sidebarWidth, mq, space, maxWidth }) => ({
	root: {

@@ -57,7 +57,7 @@

		<div className={cx(classes.root, hasSidebar && classes.hasSidebar)}>
			<main className={classes.content}>
				{children}
				<StyleguideFooter homepageUrl={HOMEPAGE} />
				<StyleguideFooter homepageUrl={consts.HOMEPAGE} />
			</main>
			{hasSidebar && (
				<div className={classes.sidebar}>

@@ -17,7 +17,8 @@

	name: string
	type?: any
	default?: string
	description?: string
	// the null is to satisfy proptypes of arguments
	description?: string | null
	returns?: boolean
	block?: boolean
}

@@ -14,7 +14,7 @@

			visibleName: PropTypes.string.isRequired
		})
	}).isRequired,
	href: PropTypes.string.isRequired,
	href: PropTypes.string,
	depth: PropTypes.number.isRequired,
	deprecated: PropTypes.bool,
	pagePerSection: PropTypes.bool

Files		•	•	•	Coverage
packages	4,786	3,062	72	1,652	63.98%
Project Totals (175 files)	4,786	3,062	72	1,652	63.98%

v12=
TRAVIS_OS_NAME=linux

View CI Build Download

No yaml found.

Create your codecov.yml to customize your Codecov experience

Read the docs

Interact now

The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.

SVG

The top section represents the entire project. Proceeding with folders and finally individual files. The size and color of each slice is representing the number of statements and the coverage, respectively.

SVG

Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.

SVG

Learn more about the coverage sunburst graph

41	41		children: PropTypes.node,
42	42		toolbar: PropTypes.node,
43	43		id: PropTypes.string.isRequired,
44		-	href: PropTypes.string.isRequired,
	44	+	href: PropTypes.string,
45	45		depth: PropTypes.number.isRequired,
46	46		deprecated: PropTypes.bool,
47	47		parentName: PropTypes.string,

17	17		name: string
18	18		type?: any
19	19		default?: string
20		-	description?: string
	20	+	// the null is to satisfy proptypes of arguments
	21	+	description?: string \| null
21	22		returns?: boolean
22	23		block?: boolean
23	24		}

Navigation	Overlay
`t` Navigate files	`h` Toggle hits
`y` Change url to tip of branch	`m` Toggle misses
`b / v` Jump to prev/next hit line	`p` Toggle partial
`z / x` Jump to prev/next missed or partial line	`1..9` Toggle flags
`shift + o` Open current page in GitHub	`a` Toggle all on
`/ or ?` Show keyboard shortcuts dialog	`c` Toggle context lines or commits

2	2		import PropTypes from 'prop-types'
3	3		import Markdown from 'rsg-components/Markdown'
4	4		import Styled from 'rsg-components/Styled'
5		-	import { DOCS_COMPONENTS } from '../../../scripts/consts'
	5	+	import consts from '../../../scripts/consts'
6	6
7	7		const styles = ({ space, maxWidth }) => ({
8	8		root: {

29	29		components: 'src/components/*/.vue'
30	30		};
31	31
32		-	Read more in the [locating components guide](${DOCS_COMPONENTS}).
	32	+	Read more in the [locating components guide](${consts.DOCS_COMPONENTS}).
33	33		`}
34	34		/>
35	35		</div>

69	69		return (
70	70		<div className={classes.wrapper}>
71	71		<Heading level={headingLevel} id={id}>
72		-	<a href={href} className={sectionNameClasses}>
73		-	{children}
74		-	</a>
	72	+	{href ? (
	73	+	<a href={href} className={sectionNameClasses}>
	74	+	{children}
	75	+	</a>
	76	+	) : (
	77	+	<span className={sectionNameClasses}>{children}</span>
	78	+	)}
75	79		{parentName && parentHref && (
76	80		<a href={parentHref} className={classes.parentName}>
77	81		{parentName}

4	4		import { getDefaultExample } from 'vue-inbrowser-compiler-utils'
5	5		import Styled from 'rsg-components/Styled'
6	6		import Markdown from 'rsg-components/Markdown'
7		-	import { DOCS_DOCUMENTING } from '../../../scripts/consts'
	7	+	import consts from '../../../scripts/consts'
8	8		import { DocumentedComponentContext } from '../VsgReactComponent/ReactComponent'
9	9
10	10		const styles = ({ fontFamily, fontSize, color }) => ({

93	93
94	94		You may need to restart the style guide server after adding an example file.
95	95
96		-	Read more in the [documenting components guide](${DOCS_DOCUMENTING}).
	96	+	Read more in the [documenting components guide](${consts.DOCS_DOCUMENTING}).
97	97		`}
98	98		/>
99	99		)

2	2		import * as Rsg from 'react-styleguidist'
3	3		import PropTypes from 'prop-types'
4	4		import Styled, { JssInjectedProps } from 'rsg-components/Styled'
5		-	import Argument, { ArgumentProps } from 'rsg-components/Argument'
	5	+	import Argument from 'rsg-components/Argument'
6	6		import Heading from 'rsg-components/Heading'
	7	+	import { ArgumentProps } from '../Argument/ArgumentRenderer'
7	8
8	9		export const styles = ({ space }: Rsg.Theme) => ({
9	10		root: {

49	50		PropTypes.shape({
50	51		name: PropTypes.string.isRequired,
51	52		type: PropTypes.object,
52		-	description: PropTypes.string.isRequired
	53	+	description: PropTypes.string
53	54		}).isRequired
54	55		).isRequired,
55	56		heading: PropTypes.bool

6	6		import cx from 'classnames'
7	7		import Ribbon from 'rsg-components/Ribbon'
8	8		import Version from 'rsg-components/Version'
9		-	import { HOMEPAGE } from '../../../scripts/consts'
	9	+	import consts from '../../../scripts/consts'
10	10
11	11		const styles = ({ color, sidebarWidth, mq, space, maxWidth }) => ({
12	12		root: {

57	57		<div className={cx(classes.root, hasSidebar && classes.hasSidebar)}>
58	58		<main className={classes.content}>
59	59		{children}
60		-	<StyleguideFooter homepageUrl={HOMEPAGE} />
	60	+	<StyleguideFooter homepageUrl={consts.HOMEPAGE} />
61	61		</main>
62	62		{hasSidebar && (
63	63		<div className={classes.sidebar}>

14	14		visibleName: PropTypes.string.isRequired
15	15		})
16	16		}).isRequired,
17		-	href: PropTypes.string.isRequired,
	17	+	href: PropTypes.string,
18	18		depth: PropTypes.number.isRequired,
19	19		deprecated: PropTypes.bool,
20	20		pagePerSection: PropTypes.bool