+
{name}
-
- {kindString}
-
+
+ {kindString}
+
- {isStatic &&
static
}
- {!isPublic && (
-
- private
-
- )}
-
- {comment && !deprecation && (
-
- {comment.text || comment.shortText}
-
- )}
-
- {deprecation && (
-
- Deprecated: use{' '}
-
-
- {deprecatedUse}
-
- {' '}
- instead
-
- )}
-
- {!deprecation &&
- (() => {
- switch (kindString) {
- case 'Method':
- return
- case 'Property':
- return
- }
- })()}
-
- {fileName && (
-
- {`${fileName}#L${line}`}
-
- )}
+ {isStatic &&
static
}
+ {!isPublic && (
+
+ private
- )
+ )}
+
+ {comment && !deprecation && (
+
+ {comment.text || comment.shortText}
+
+ )}
+
+ {deprecation && (
+
+ Deprecated: use{' '}
+
+
+ {deprecatedUse}
+
+ {' '}
+ instead
+
+ )}
+
+ {!deprecation &&
+ (() => {
+ switch (kindString) {
+ case 'Method':
+ return
+ case 'Property':
+ return
+ }
+ })()}
+
+ {fileName && (
+
+ {`${fileName}#L${line}`}
+
+ )}
+
+ )
}
PropertyWrapper.propTypes = {
- property: PropTypes.object,
- sourceUrl: PropTypes.string,
- parentAnchor: PropTypes.string
+ property: PropTypes.object,
+ sourceUrl: PropTypes.string,
+ parentAnchor: PropTypes.string
}
const Entities = ({ entities, sourceUrl }) =>
- entities.map(({ name, comment, children }) => (
-
-
- {name}
-
+ entities.map(({ name, comment, children }) => (
+
+
+ {name}
+
- {comment && (
-
- {comment.text || comment.shortText}
-
- )}
-
- {children &&
- children
- .filter(filterByKindOfProperty)
- .map((property) => (
-
- ))}
+ {comment && (
+
+ {comment.text || comment.shortText}
- ))
+ )}
+
+ {children &&
+ children
+ .filter(filterByKindOfProperty)
+ .map((property) => (
+
+ ))}
+
+ ))
Entities.propTypes = {
- entities: PropTypes.array.isRequired,
- sourceUrl: PropTypes.string
+ entities: PropTypes.array.isRequired,
+ sourceUrl: PropTypes.string
}
export default Entities
diff --git a/src/templates/Typedoc/Entities.module.scss b/src/templates/Typedoc/Entities.module.scss
index 4bfbc783..9321d33c 100644
--- a/src/templates/Typedoc/Entities.module.scss
+++ b/src/templates/Typedoc/Entities.module.scss
@@ -1,165 +1,165 @@
@import 'variables';
.entityName {
- // stylelint-disable value-keyword-case
- composes: pathname from '../Doc.module.scss';
- // stylelint-enable value-keyword-case
- font-size: $font-size-h2;
+ // stylelint-disable value-keyword-case
+ composes: pathname from '../Doc.module.scss';
+ // stylelint-enable value-keyword-case
+ font-size: $font-size-h2;
}
.entityDescription {
- padding-bottom: $spacer;
- white-space: pre-line;
+ padding-bottom: $spacer;
+ white-space: pre-line;
}
.property {
- padding: $spacer / 2;
- border: 1px solid $brand-grey-lighter;
- margin-bottom: $spacer;
- border-radius: $border-radius;
- position: relative;
+ padding: $spacer / 2;
+ border: 1px solid $brand-grey-lighter;
+ margin-bottom: $spacer;
+ border-radius: $border-radius;
+ position: relative;
- &[data-deprecated='true'] {
- > *:not(.deprecation) {
- opacity: .5;
- }
-
- code {
- opacity: 1;
- background: none;
- padding: 0;
- }
-
- .sourceLink {
- display: none;
- }
+ &[data-deprecated='true'] {
+ > *:not(.deprecation) {
+ opacity: 0.5;
}
+
+ code {
+ opacity: 1;
+ background: none;
+ padding: 0;
+ }
+
+ .sourceLink {
+ display: none;
+ }
+ }
}
.propertyName,
.propertyType,
.propertyModifier {
- font-size: $font-size-base;
- font-family: $font-family-monospace;
- margin-bottom: $spacer / 4;
- margin-top: 0;
- display: inline-block;
- padding: 0 $spacer / 4;
- border-radius: $border-radius;
- vertical-align: middle;
+ font-size: $font-size-base;
+ font-family: $font-family-monospace;
+ margin-bottom: $spacer / 4;
+ margin-top: 0;
+ display: inline-block;
+ padding: 0 $spacer / 4;
+ border-radius: $border-radius;
+ vertical-align: middle;
}
.propertyName {
- font-size: $font-size-large;
- padding: 0;
- margin-right: $spacer / 3;
+ font-size: $font-size-large;
+ padding: 0;
+ margin-right: $spacer / 3;
}
.propertyType,
.propertyModifier {
- font-size: $font-size-small;
- color: $brand-grey;
- margin-right: $spacer / 4;
+ font-size: $font-size-small;
+ color: $brand-grey;
+ margin-right: $spacer / 4;
}
.propertyType {
- &[data-type='method'] {
- background: rgba($green, .3);
- }
+ &[data-type='method'] {
+ background: rgba($green, 0.3);
+ }
- &[data-type='property'] {
- background: rgba($yellow, .3);
- }
+ &[data-type='property'] {
+ background: rgba($yellow, 0.3);
+ }
}
.propertyModifier {
- background: rgba($red, .2);
+ background: rgba($red, 0.2);
- &[data-secondary] {
- background: rgba($brand-blue, .2);
- }
+ &[data-secondary] {
+ background: rgba($brand-blue, 0.2);
+ }
}
.propertyDescription {
- margin-bottom: $spacer;
+ margin-bottom: $spacer;
}
.sourceLink {
- display: block;
- font-size: $font-size-mini;
- color: $brand-grey-light;
- margin-top: $spacer / 2;
+ display: block;
+ font-size: $font-size-mini;
+ color: $brand-grey-light;
+ margin-top: $spacer / 2;
- &:hover,
- &:focus {
- transform: none;
- }
+ &:hover,
+ &:focus {
+ transform: none;
+ }
- @media (min-width: $break-point--large) {
- margin-top: 0;
- position: absolute;
- bottom: $spacer / 2;
- right: $spacer / 2;
- }
+ @media (min-width: $break-point--large) {
+ margin-top: 0;
+ position: absolute;
+ bottom: $spacer / 2;
+ right: $spacer / 2;
+ }
}
.deprecation {
- font-size: $font-size-small;
- margin-top: $spacer / 4;
+ font-size: $font-size-small;
+ margin-top: $spacer / 4;
- strong {
- color: $brand-grey-light;
- }
+ strong {
+ color: $brand-grey-light;
+ }
}
.type {
- display: inline-block;
- color: $brand-grey;
- font-family: $font-family-monospace;
- font-size: $font-size-small;
+ display: inline-block;
+ color: $brand-grey;
+ font-family: $font-family-monospace;
+ font-size: $font-size-small;
- a {
- &:hover {
- opacity: .6;
- }
+ a {
+ &:hover {
+ opacity: 0.6;
}
+ }
}
.typeSymbol {
- opacity: .6;
+ opacity: 0.6;
}
.subHeading {
- font-size: $font-size-base;
- border-bottom: 1px solid $brand-grey-lighter;
- padding-bottom: $spacer / 4;
- margin-bottom: $spacer / 4;
- color: $brand-grey;
+ font-size: $font-size-base;
+ border-bottom: 1px solid $brand-grey-lighter;
+ padding-bottom: $spacer / 4;
+ margin-bottom: $spacer / 4;
+ color: $brand-grey;
}
.parameters {
- margin-top: $spacer / 1.5;
+ margin-top: $spacer / 1.5;
- h5,
- p {
- margin: 0;
- }
+ h5,
+ p {
+ margin: 0;
+ }
- h5 {
- font-size: $font-size-small;
- margin-bottom: $spacer / 4;
- margin-right: $spacer / 4;
- margin-left: -(.2rem);
- display: inline-block;
- }
+ h5 {
+ font-size: $font-size-small;
+ margin-bottom: $spacer / 4;
+ margin-right: $spacer / 4;
+ margin-left: -(0.2rem);
+ display: inline-block;
+ }
- code {
- padding: .2rem;
- }
+ code {
+ padding: 0.2rem;
+ }
}
.parameterOptional {
- font-size: $font-size-small;
- vertical-align: top;
- color: $brand-purple;
+ font-size: $font-size-small;
+ vertical-align: top;
+ color: $brand-purple;
}
diff --git a/src/templates/Typedoc/Toc.jsx b/src/templates/Typedoc/Toc.jsx
index cc9fa2fd..6845df72 100644
--- a/src/templates/Typedoc/Toc.jsx
+++ b/src/templates/Typedoc/Toc.jsx
@@ -8,63 +8,59 @@ import { filterByKindOfProperty } from './utils'
import stylesSidebar from '../../components/Sidebar.module.scss'
export default class Toc extends PureComponent {
- static propTypes = {
- data: PropTypes.array
- }
+ static propTypes = {
+ data: PropTypes.array
+ }
- subItems = (children, parentName) =>
- children &&
- children.filter(filterByKindOfProperty).map(({ name, decorators }) => {
- const deprecation = (decorators || []).filter(
- ({ name }) => name === 'deprecated'
- )[0] // Assuming deprecated annotation
+ subItems = (children, parentName) =>
+ children &&
+ children.filter(filterByKindOfProperty).map(({ name, decorators }) => {
+ const deprecation = (decorators || []).filter(
+ ({ name }) => name === 'deprecated'
+ )[0] // Assuming deprecated annotation
- return (
-
-
- {name}
-
-
- )
- })
-
- items = this.props.data.map(({ name, children }) => {
- const subIds = []
- const parentName = name
-
- subIds.push(
- children &&
- children.filter(filterByKindOfProperty).map(({ name }) => {
- return `${parentName}-${name && slugify(name)}`
- })
- )
-
- return (
-
-
- {name}
-
-
- {this.subItems(children, name)}
-
-
- )
+ return (
+
+
+ {name}
+
+
+ )
})
- render() {
- return
- }
+ items = this.props.data.map(({ name, children }) => {
+ const subIds = []
+ const parentName = name
+
+ subIds.push(
+ children &&
+ children.filter(filterByKindOfProperty).map(({ name }) => {
+ return `${parentName}-${name && slugify(name)}`
+ })
+ )
+
+ return (
+
+
+ {name}
+
+
+ {this.subItems(children, name)}
+
+
+ )
+ })
+
+ render() {
+ return
+ }
}
diff --git a/src/templates/Typedoc/index.jsx b/src/templates/Typedoc/index.jsx
index f323f3a3..791c7c5d 100644
--- a/src/templates/Typedoc/index.jsx
+++ b/src/templates/Typedoc/index.jsx
@@ -16,95 +16,89 @@ import Toc from './Toc'
import stylesDoc from '../Doc.module.scss'
export default class TypedocTemplate extends Component {
- static propTypes = {
- data: PropTypes.object.isRequired,
- location: PropTypes.object.isRequired,
- pageContext: PropTypes.object.isRequired
+ static propTypes = {
+ data: PropTypes.object.isRequired,
+ location: PropTypes.object.isRequired,
+ pageContext: PropTypes.object.isRequired
+ }
+
+ typedocCleaned = cleanTypedocData(
+ this.props.pageContext.typedoc,
+ this.props.pageContext.classes
+ )
+
+ // output section title as defined in sections.yml
+ sectionTitle = this.props.data.allSectionsYaml.edges.map(({ node }) => {
+ // compare section against section title from sections.yml
+ if (node.title.toLowerCase().includes('references')) {
+ return node.title
}
+ })
- typedocCleaned = cleanTypedocData(
- this.props.pageContext.typedoc,
- this.props.pageContext.classes
- )
+ render() {
+ const { location, pageContext } = this.props
+ const { typedoc } = pageContext
+ const { info } = typedoc
+ const { title, description, version, sourceUrl } = info
- // output section title as defined in sections.yml
- sectionTitle = this.props.data.allSectionsYaml.edges.map(({ node }) => {
- // compare section against section title from sections.yml
- if (node.title.toLowerCase().includes('references')) {
- return node.title
- }
- })
+ return (
+ <>
+
+
+
- render() {
- const { location, pageContext } = this.props
- const { typedoc } = pageContext
- const { info } = typedoc
- const { title, description, version, sourceUrl } = info
+
- return (
- <>
-
-
-
+
+
-
+
+
+
+ {version}}
/>
-
-
-
-
-
-
-
-
- {version}
-
- }
- />
-
-
-
-
-
-
-
- )
- }
+
+
+
+
+
+
+ )
+ }
}
export const TypedocQuery = graphql`
- query {
- allSectionsYaml {
- edges {
- node {
- title
- description
- link
- }
- }
+ query {
+ allSectionsYaml {
+ edges {
+ node {
+ title
+ description
+ link
}
+ }
}
+ }
`
diff --git a/src/templates/Typedoc/utils.js b/src/templates/Typedoc/utils.js
index 80b0dab1..99a49382 100644
--- a/src/templates/Typedoc/utils.js
+++ b/src/templates/Typedoc/utils.js
@@ -1,48 +1,44 @@
export const cleanTypedocData = (data, useClasses) => {
- const nodes = data.children
+ const nodes = data.children
- const cleanData = nodes
- .map((node) => {
- const child =
- node.children &&
- node.children.filter(
- ({ kindString }) => kindString === 'Class'
- )[0]
+ const cleanData = nodes
+ .map((node) => {
+ const child =
+ node.children &&
+ node.children.filter(({ kindString }) => kindString === 'Class')[0]
- return {
- ...node,
- name: node.name.replace(/"/g, '').replace('src/', ''),
- child
- }
- })
- .filter(({ name }) => (useClasses || []).includes(name))
- .sort((a, b) => useClasses.indexOf(a.name) - useClasses.indexOf(b.name))
- .map(({ child }) => child)
- .map((node) => ({
- ...node,
- children:
- node &&
- node.children &&
- node.children.sort((a, b) => a.id - b.id)
- }))
+ return {
+ ...node,
+ name: node.name.replace(/"/g, '').replace('src/', ''),
+ child
+ }
+ })
+ .filter(({ name }) => (useClasses || []).includes(name))
+ .sort((a, b) => useClasses.indexOf(a.name) - useClasses.indexOf(b.name))
+ .map(({ child }) => child)
+ .map((node) => ({
+ ...node,
+ children:
+ node && node.children && node.children.sort((a, b) => a.id - b.id)
+ }))
- return cleanData
+ return cleanData
}
// more kinds: 'Property', 'Enumeration'
const showKindOfProperty = {
- Method: { onlyPublic: true },
- Property: { onlyPublic: true }
+ Method: { onlyPublic: true },
+ Property: { onlyPublic: true }
}
export const filterByKindOfProperty = ({ kindString, flags }) => {
- const config = showKindOfProperty[kindString]
- if (!config) return
+ const config = showKindOfProperty[kindString]
+ if (!config) return
- // filter out static methods by default
- if (flags.isStatic) return
+ // filter out static methods by default
+ if (flags.isStatic) return
- if (config.onlyPublic && !flags.isPublic) return
+ if (config.onlyPublic && !flags.isPublic) return
- return true
+ return true
}