From c9959ad3bb2d7eb71ef9a010fa261418fd32d9e1 Mon Sep 17 00:00:00 2001 From: Alexandre Fauquette Date: Fri, 26 Aug 2022 10:59:04 +0200 Subject: [PATCH] yarn docs:api --- .../api-docs/date-pickers/date-range-picker-pt.json | 2 +- .../api-docs/date-pickers/date-range-picker-zh.json | 2 +- docs/translations/api-docs/date-pickers/date-range-picker.json | 2 +- .../api-docs/date-pickers/desktop-date-range-picker-pt.json | 2 +- .../api-docs/date-pickers/desktop-date-range-picker-zh.json | 2 +- .../api-docs/date-pickers/desktop-date-range-picker.json | 2 +- .../api-docs/date-pickers/mobile-date-range-picker-pt.json | 2 +- .../api-docs/date-pickers/mobile-date-range-picker-zh.json | 2 +- .../api-docs/date-pickers/mobile-date-range-picker.json | 2 +- .../api-docs/date-pickers/static-date-range-picker-pt.json | 2 +- .../api-docs/date-pickers/static-date-range-picker-zh.json | 2 +- .../api-docs/date-pickers/static-date-range-picker.json | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/translations/api-docs/date-pickers/date-range-picker-pt.json b/docs/translations/api-docs/date-pickers/date-range-picker-pt.json index ca010ef97e88..6a76893c0e23 100644 --- a/docs/translations/api-docs/date-pickers/date-range-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/date-range-picker-pt.json @@ -47,7 +47,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/date-range-picker-zh.json b/docs/translations/api-docs/date-pickers/date-range-picker-zh.json index ca010ef97e88..6a76893c0e23 100644 --- a/docs/translations/api-docs/date-pickers/date-range-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/date-range-picker-zh.json @@ -47,7 +47,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/date-range-picker.json b/docs/translations/api-docs/date-pickers/date-range-picker.json index ca010ef97e88..6a76893c0e23 100644 --- a/docs/translations/api-docs/date-pickers/date-range-picker.json +++ b/docs/translations/api-docs/date-pickers/date-range-picker.json @@ -47,7 +47,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/desktop-date-range-picker-pt.json b/docs/translations/api-docs/date-pickers/desktop-date-range-picker-pt.json index 9d021c38bd1c..efd923f090cf 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-range-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-range-picker-pt.json @@ -45,7 +45,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/desktop-date-range-picker-zh.json b/docs/translations/api-docs/date-pickers/desktop-date-range-picker-zh.json index 9d021c38bd1c..efd923f090cf 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-range-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-range-picker-zh.json @@ -45,7 +45,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json b/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json index 9d021c38bd1c..efd923f090cf 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json @@ -45,7 +45,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-range-picker-pt.json b/docs/translations/api-docs/date-pickers/mobile-date-range-picker-pt.json index e692e92383bf..f7c3789b0a21 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-range-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-range-picker-pt.json @@ -44,7 +44,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-range-picker-zh.json b/docs/translations/api-docs/date-pickers/mobile-date-range-picker-zh.json index e692e92383bf..f7c3789b0a21 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-range-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-range-picker-zh.json @@ -44,7 +44,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json b/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json index e692e92383bf..f7c3789b0a21 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json @@ -44,7 +44,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/static-date-range-picker-pt.json b/docs/translations/api-docs/date-pickers/static-date-range-picker-pt.json index 400c847e8fed..9cf47868e35e 100644 --- a/docs/translations/api-docs/date-pickers/static-date-range-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/static-date-range-picker-pt.json @@ -41,7 +41,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/static-date-range-picker-zh.json b/docs/translations/api-docs/date-pickers/static-date-range-picker-zh.json index 400c847e8fed..9cf47868e35e 100644 --- a/docs/translations/api-docs/date-pickers/static-date-range-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/static-date-range-picker-zh.json @@ -41,7 +41,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.", diff --git a/docs/translations/api-docs/date-pickers/static-date-range-picker.json b/docs/translations/api-docs/date-pickers/static-date-range-picker.json index 400c847e8fed..9cf47868e35e 100644 --- a/docs/translations/api-docs/date-pickers/static-date-range-picker.json +++ b/docs/translations/api-docs/date-pickers/static-date-range-picker.json @@ -41,7 +41,7 @@ "renderLoading": "Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", - "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end' for range pickers.
returns (boolean): Returns true if the date should be disabled.", + "shouldDisableDate": "Disable specific date. @DateIOType

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.", "shouldDisableMonth": "Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.", "shouldDisableYear": "Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.", "showDaysOutsideCurrentMonth": "If true, days that have outsideCurrentMonth={true} are displayed.",