mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-24 03:16:40 +00:00
Replace GitBook.Shapes by GitBook.PropTypes
This commit is contained in:
+1
-1
@@ -1,4 +1,4 @@
|
||||
# Context and APIs
|
||||
# Node APIs
|
||||
|
||||
GitBooks provides different Node APIs and contexts to plugins. These APIs can vary according to the GitBook version being used, your plugin should specify the `engines.gitbook` field in `package.json` accordingly.
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
const React = require('react');
|
||||
const { Provider } = require('react-redux');
|
||||
|
||||
const ContextShape = require('../shapes/Context');
|
||||
const ContextShape = require('../propTypes/Context');
|
||||
|
||||
/**
|
||||
* React component to provide a GitBook context to children components.
|
||||
|
||||
@@ -3,8 +3,8 @@ const ReactRedux = require('react-redux');
|
||||
|
||||
const File = require('../models/File');
|
||||
const SummaryArticle = require('../models/SummaryArticle');
|
||||
const SummaryArticleShape = require('../shapes/SummaryArticle');
|
||||
const FileShape = require('../shapes/File');
|
||||
const SummaryArticleShape = require('../propTypes/SummaryArticle');
|
||||
const FileShape = require('../propTypes/File');
|
||||
|
||||
const Link = React.createClass({
|
||||
propTypes: {
|
||||
|
||||
@@ -23,7 +23,7 @@ const I18nProvider = require('./components/I18nProvider');
|
||||
|
||||
const ACTIONS = require('./actions/TYPES');
|
||||
|
||||
const Shapes = require('./shapes');
|
||||
const PropTypes = require('./propTypes');
|
||||
const connect = require('./lib/connect');
|
||||
const createPlugin = require('./lib/createPlugin');
|
||||
const createReducer = require('./lib/createReducer');
|
||||
@@ -63,7 +63,7 @@ module.exports = {
|
||||
Backdrop,
|
||||
Tooltipped,
|
||||
// Utilities
|
||||
Shapes,
|
||||
PropTypes,
|
||||
// Librairies
|
||||
React,
|
||||
Immutable,
|
||||
|
||||
@@ -2,7 +2,7 @@ const React = require('react');
|
||||
const ReactRedux = require('react-redux');
|
||||
const { injectIntl } = require('react-intl');
|
||||
|
||||
const ContextShape = require('../shapes/Context');
|
||||
const ContextShape = require('../propTypes/Context');
|
||||
|
||||
/**
|
||||
* Use the GitBook context provided by ContextProvider to map actions to props
|
||||
|
||||
@@ -5,7 +5,7 @@ const PJAXWrapper = require('../components/PJAXWrapper');
|
||||
const I18nProvider = require('../components/I18nProvider');
|
||||
const ContextProvider = require('../components/ContextProvider');
|
||||
const History = require('../actions/history');
|
||||
const contextShape = require('../shapes/context');
|
||||
const contextShape = require('../propTypes/context');
|
||||
|
||||
const GitBookApplication = React.createClass({
|
||||
propTypes: {
|
||||
|
||||
@@ -23,7 +23,7 @@ function getChildrenToText(children) {
|
||||
let CodeBlockWithCopy = React.createClass({
|
||||
propTypes: {
|
||||
children: React.PropTypes.node,
|
||||
i18n: GitBook.Shapes.I18n
|
||||
i18n: GitBook.PropTypes.I18n
|
||||
},
|
||||
|
||||
getInitialState() {
|
||||
|
||||
@@ -6,8 +6,8 @@ const search = require('../actions/search');
|
||||
const SearchInput = React.createClass({
|
||||
propTypes: {
|
||||
query: React.PropTypes.string,
|
||||
i18n: GitBook.Shapes.I18n,
|
||||
dispatch: GitBook.Shapes.dispatch
|
||||
i18n: GitBook.PropTypes.I18n,
|
||||
dispatch: GitBook.PropTypes.dispatch
|
||||
},
|
||||
|
||||
onChange(event) {
|
||||
|
||||
@@ -42,8 +42,8 @@ const Result = React.createClass({
|
||||
|
||||
const SearchResults = React.createClass({
|
||||
propTypes: {
|
||||
i18n: GitBook.Shapes.I18n,
|
||||
results: GitBook.Shapes.list,
|
||||
i18n: GitBook.PropTypes.I18n,
|
||||
results: GitBook.PropTypes.list,
|
||||
query: React.PropTypes.string,
|
||||
children: React.PropTypes.node
|
||||
},
|
||||
|
||||
@@ -12,7 +12,7 @@ const ShareButton = require('./ShareButton');
|
||||
const SharingButtons = React.createClass({
|
||||
propTypes: {
|
||||
options: optionsShape.isRequired,
|
||||
page: GitBook.Shapes.Page.isRequired
|
||||
page: GitBook.PropTypes.Page.isRequired
|
||||
},
|
||||
|
||||
onShare(site) {
|
||||
|
||||
@@ -6,8 +6,8 @@ const Toolbar = require('./Toolbar');
|
||||
|
||||
const Body = React.createClass({
|
||||
propTypes: {
|
||||
page: GitBook.Shapes.Page,
|
||||
readme: GitBook.Shapes.Readme
|
||||
page: GitBook.PropTypes.Page,
|
||||
readme: GitBook.PropTypes.Readme
|
||||
},
|
||||
|
||||
render() {
|
||||
|
||||
@@ -3,7 +3,7 @@ const { React } = GitBook;
|
||||
|
||||
const Page = React.createClass({
|
||||
propTypes: {
|
||||
page: GitBook.Shapes.Page
|
||||
page: GitBook.PropTypes.Page
|
||||
},
|
||||
|
||||
render() {
|
||||
|
||||
@@ -5,7 +5,7 @@ const Summary = require('./Summary');
|
||||
|
||||
const Sidebar = React.createClass({
|
||||
propTypes: {
|
||||
summary: GitBook.Shapes.Summary
|
||||
summary: GitBook.PropTypes.Summary
|
||||
},
|
||||
|
||||
render() {
|
||||
|
||||
@@ -5,7 +5,7 @@ const { React } = GitBook;
|
||||
let SummaryArticle = React.createClass({
|
||||
propTypes: {
|
||||
active: React.PropTypes.bool,
|
||||
article: GitBook.Shapes.SummaryArticle
|
||||
article: GitBook.PropTypes.SummaryArticle
|
||||
},
|
||||
|
||||
render() {
|
||||
@@ -33,7 +33,7 @@ SummaryArticle = GitBook.connect(SummaryArticle, ({page}, {article}) => {
|
||||
|
||||
const SummaryArticles = React.createClass({
|
||||
propTypes: {
|
||||
articles: GitBook.Shapes.listOf(GitBook.Shapes.SummaryArticle)
|
||||
articles: GitBook.PropTypes.listOf(GitBook.PropTypes.SummaryArticle)
|
||||
},
|
||||
|
||||
render() {
|
||||
@@ -51,7 +51,7 @@ const SummaryArticles = React.createClass({
|
||||
|
||||
const SummaryPart = React.createClass({
|
||||
propTypes: {
|
||||
part: GitBook.Shapes.SummaryPart
|
||||
part: GitBook.PropTypes.SummaryPart
|
||||
},
|
||||
|
||||
render() {
|
||||
@@ -73,7 +73,7 @@ const SummaryPart = React.createClass({
|
||||
|
||||
const SummaryParts = React.createClass({
|
||||
propTypes: {
|
||||
parts: GitBook.Shapes.listOf(GitBook.Shapes.SummaryPart)
|
||||
parts: GitBook.PropTypes.listOf(GitBook.PropTypes.SummaryPart)
|
||||
},
|
||||
|
||||
render() {
|
||||
@@ -91,7 +91,7 @@ const SummaryParts = React.createClass({
|
||||
|
||||
const Summary = React.createClass({
|
||||
propTypes: {
|
||||
summary: GitBook.Shapes.Summary
|
||||
summary: GitBook.PropTypes.Summary
|
||||
},
|
||||
|
||||
render() {
|
||||
|
||||
@@ -8,10 +8,10 @@ const LoadingBar = require('./LoadingBar');
|
||||
const Theme = React.createClass({
|
||||
propTypes: {
|
||||
// State
|
||||
page: GitBook.Shapes.Page,
|
||||
summary: GitBook.Shapes.Summary,
|
||||
readme: GitBook.Shapes.Readme,
|
||||
history: GitBook.Shapes.History,
|
||||
page: GitBook.PropTypes.Page,
|
||||
summary: GitBook.PropTypes.Summary,
|
||||
readme: GitBook.PropTypes.Readme,
|
||||
history: GitBook.PropTypes.History,
|
||||
sidebar: React.PropTypes.object,
|
||||
// Other props
|
||||
children: React.PropTypes.node
|
||||
|
||||
@@ -7,7 +7,7 @@ const Toolbar = React.createClass({
|
||||
propTypes: {
|
||||
title: React.PropTypes.string.isRequired,
|
||||
dispatch: React.PropTypes.func,
|
||||
readme: GitBook.Shapes.Readme
|
||||
readme: GitBook.PropTypes.Readme
|
||||
},
|
||||
|
||||
onToggle() {
|
||||
|
||||
Reference in New Issue
Block a user