Commit 20462ce

committed

docs(Envelope): update feature related contents

1 parent 1494796 commit 20462ceCopy full SHA for 20462ce

File tree

+13

-5

lines changed

+13

-5

lines changed

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -34,14 +34,15 @@ By passing the `delay` parameter to the `data` prop, you can introduce delay poi
`34`	`34`
`35`	`35`	`## Type Declarations`
`36`	`36`
`37`		-<CodeBlock code={`export interface EnvelopeProps extends React.HTMLAttributes<EnvelopeRef> {
	`37`	+<CodeBlock code={`export interface EnvelopeProps extends Omit<React.HTMLAttributes<EnvelopeRef>, 'onChange'> {
`38`	`38`	`data: EnvelopeData`
`39`	`39`	`limits?: EnvelopeLimits`
`40`	`40`	`lineColor?: string`
`41`	`41`	`lineWidth?: number`
`42`	`42`	`nodeColor?: string`
`43`	`43`	`nodeSize?: number`
`44`		`- onDataChange?: (data: EnvelopeData) => void`
	`44`	`+ onChange?: (data: EnvelopeData) => void`
	`45`	`+ onChangeEnd?: (data: EnvelopeData) => void`
`45`	`46`	`}`
`46`	`47`
`47`	`48`	`export interface EnvelopeData {`

Lines changed: 7 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -41,11 +41,17 @@ export const EnvelopeAPITable = () => {`
`41`	`41`	`default: <Code>6</Code>,`
`42`	`42`	`},`
`43`	`43`	`{`
`44`		`- attribute: 'onDataChange',`
	`44`	`+ attribute: 'onChange',`
`45`	`45`	`description: 'The callback function when data changed',`
`46`	`46`	type: <Code>{`(data: EnvelopeData) => void`}</Code>,
`47`	`47`	`default: '-',`
`48`	`48`	`},`
	`49`	`+ {`
	`50`	`+ attribute: 'onChangeEnd',`
	`51`	`+ description: 'The callback function when data changed ended',`
	`52`	+ type: <Code>{`(data: EnvelopeData) => void`}</Code>,
	`53`	`+ default: '-',`
	`54`	`+ },`
`49`	`55`	`]`
`50`	`56`
`51`	`57`	`return <APITable data={data} />`

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -34,14 +34,15 @@ Envelope 是一个 [ADSR](https://en.wikipedia.org/wiki/Synthesizer#ADSR_envelop`
`34`	`34`
`35`	`35`	`## 类型声明`
`36`	`36`
`37`		-<CodeBlock code={`export interface EnvelopeProps extends React.HTMLAttributes<EnvelopeRef> {
	`37`	+<CodeBlock code={`export interface EnvelopeProps extends Omit<React.HTMLAttributes<EnvelopeRef>, 'onChange'> {
`38`	`38`	`data: EnvelopeData`
`39`	`39`	`limits?: EnvelopeLimits`
`40`	`40`	`lineColor?: string`
`41`	`41`	`lineWidth?: number`
`42`	`42`	`nodeColor?: string`
`43`	`43`	`nodeSize?: number`
`44`		`- onDataChange?: (data: EnvelopeData) => void`
	`44`	`+ onChange?: (data: EnvelopeData) => void`
	`45`	`+ onChangeEnd?: (data: EnvelopeData) => void`
`45`	`46`	`}`
`46`	`47`
`47`	`48`	`export interface EnvelopeData {`

Comments

(0)