テキストエディタSvelteコンポーネント

    テキストエディタSvelteコンポーネントは、テキストエディタコンポーネントを表します。

    テキストエディタコンポーネント

    以下のコンポーネントが含まれています。

    • テキストエディタ(TextEditor)

    テキストエディタのプロパティ

    PropTypeDefaultDescription
    <TextEditor> properties
    valuestring

    テキストエディタの初期htmlコンテンツの値です。

    placeholderstring空の時に表示されるエディタのプレースホルダーコンテンツです。デフォルトでは指定されていません。
    resizablebooleanfalseエディタのサイズを変更可能にします(コンテンツに合わせて高さを変更します)。
    modestringtoolbar

    テキスト・エディタのボタン・モード。次のようになります。

    • toolbar - テキストエディタのコンテナ要素に、エディタボタン付きのツールバーを追加します。
    • popover - エディタで選択されたテキストの上に、エディタボタンの付いたポップオーバーバブルを表示します。
    • keyboard-toolbar - エディタがフォーカスされているときに、仮想キーボードの上にエディタボタン付きのツールバーが表示されます。この機能は、iOS、Androidのcordovaアプリ、AndroidのChromeでのみサポートされています。サポートされていない場合は、popover モードにフォールバックします。
    buttonsarray

    エディタボタンを持つ配列、または、エディタボタンを持つ配列(グループ)の配列です。デフォルトでは、すべてのボタンが有効で、そのデフォルト値は:

    [
      ['bold', 'italic', 'underline', 'strikeThrough'],
      ['orderedList', 'unorderedList'],
      ['link', 'image'],
      ['paragraph', 'h1', 'h2', 'h3'],
      ['alignLeft', 'alignCenter', 'alignRight', 'alignJustify'],
      ['subscript', 'superscript'],
      ['indent', 'outdent'],
    ]
    dividersbooleantrueボタングループの間に、視覚的な仕切りを追加します。
    imageUrlTextstringInsert image URLイメージのURLリクエストに表示されるプロンプトテキスト
    linkUrlTextstringInsert link URLリンクのURLリクエスト時に表示されるプロンプトテキスト
    clearFormattingOnPastebooleantrue有効にすると、クリップボードからのペースト時にフォーマットをクリアします。
    customButtonsobject

    カスタムボタンを持つオブジェクトです。オブジェクトのプロパティkeyには、buttonsで有効にするボタンのidを指定します。

    例えば、<hr>を追加するカスタムボタンを指定するには、以下の宣言を使用します。

    <TextEditor
      customButtons={{
        // property keyはボタンのIDです。
        hr: {
          // ボタンのHTMLコンテンツ
          content: '&lt;hr&gt;',
          // ボタンのクリックハンドラ
          onClick(event, buttonEl) {
            document.execCommand('insertHorizontalRule', false);
          }
        }
      }}
      buttons={['bold', 'italic', 'hr']}
    />
    `

    テキストエディタのイベント

    EventArgumentsDescription
    <TextEditor> events
    textEditorChange(value)エディタの値が変更されると、イベントが発生します。
    textEditorInputイベントは、エディタのコンテンツの "input "イベントでトリガされます。
    textEditorFocusイベントは、エディタのコンテンツのフォーカスでトリガされます。
    textEditorBlurイベントは、エディタのコンテンツのブラーでトリガされます。
    textEditorButtonClick(buttonId)イベントは、エディタボタンのクリックでトリガされます。
    textEditorKeyboardOpenイベントは、エディタキーボードツールバーが表示されたときにトリガされます。
    textEditorKeyboardCloseイベントは、エディタキーボードツールバーが消えたときにトリガされます。
    textEditorPopoverOpenイベントはエディタポップオーバーオープンでトリガされます。
    textEditorPopoverCloseイベントはエディタポップオーバーが閉じた時に発生します。
    textEditorBeforeDestroyイベントは、テキスト・エディタ・インスタンスが破壊される直前に発生します。

    テキストエディタのインスタンスへのアクセス

    テキストエディタAPIを使用する必要がある場合は、.instance()コンポーネントのメソッドを呼び出すことで、初期化されたインスタンスにアクセスできます。例えば

    <TextEditor bind:this={component}>...</TextEditor>
    
    <script>
      let component;
    
      // あるメソッドでインスタンスを取得するために
      component.instance()
    </script>
    
    

    Examples

    <Page>
      <Navbar title="Text Editor"></Navbar>
    
      <Block>
        <p>Framework7 comes with a touch-friendly Rich Text Editor component. It is based on modern "contenteditable" API so it should work everywhere as is.</p>
        <p>It comes with the basic set of formatting features. But its functionality can be easily extended and customized to fit any requirements.</p>
      </Block>
    
      <BlockTitle>Default Setup</BlockTitle>
      <TextEditor />
    
      <BlockTitle>With Placeholder</BlockTitle>
      <TextEditor
        placeholder="Enter text..."
      />
    
      <BlockTitle>With Default Value</BlockTitle>
      <TextEditor
        placeholder="Enter text..."
        value={customValue}
        onTextEditorChange={(value) => customValue = value}
      />
    
      <BlockTitle>Specific Buttons</BlockTitle>
      <BlockHeader>It is possible to customize which buttons (commands) to show.</BlockHeader>
      <TextEditor
        placeholder="Enter text..."
        buttons={[
          ['bold', 'italic', 'underline', 'strikeThrough'],
          ['orderedList', 'unorderedList']
        ]}
      />
    
      <BlockTitle>Custom Button</BlockTitle>
      <BlockHeader>It is possible to create custom editor buttons. Here is the custom "hr" button that adds horizontal rule:</BlockHeader>
      <TextEditor
        placeholder="Enter text..."
        customButtons={customButtons}
        buttons={[
          ['bold', 'italic', 'underline', 'strikeThrough'],
          'hr'
        ]}
      />
    
      <BlockTitle>Resizable</BlockTitle>
      <BlockHeader>Editor will be resized based on its content.</BlockHeader>
      <TextEditor
        placeholder="Enter text..."
        resizable
        buttons={['bold', 'italic', 'underline', 'strikeThrough']}
      />
    
      <BlockTitle>Popover Mode</BlockTitle>
      <BlockHeader>In this mode, there is no toolbar with buttons, but they appear as popover when you select any text in editor.</BlockHeader>
      <TextEditor
        placeholder="Enter text..."
        mode="popover"
        buttons={['bold', 'italic', 'underline', 'strikeThrough']}
        style="--f7-text-editor-height: 150px"
      />
    
      <BlockTitle>Keyboard Toolbar Mode</BlockTitle>
      <BlockHeader>In this mode, toolbar with buttons will appear on top of virtual keyboard when editor is in the focus. It is supported only in iOS, Android cordova apps and in Android Chrome. When not supported it will fallback to "popover" mode.</BlockHeader>
      <TextEditor
        placeholder="Enter text..."
        mode="keyboard-toolbar"
        style="--f7-text-editor-height: 150px"
      />
    
      <BlockTitle>As List Input</BlockTitle>
      <BlockHeader>Text editor can be used in list with other inputs. In this example it is enabled with "keyboard-toolbar"/"popover" type for "About" field.</BlockHeader>
      <List>
        <ListInput
          type="text"
          label="Name"
          placeholder="Your name"
        />
        <ListInput
          type="texteditor"
          label="About"
          placeholder="About"
          resizable
          textEditorParams={{
            mode: 'popover',
            buttons: ['bold', 'italic', 'underline', 'strikeThrough']
          }}
          value={listEditorValue}
          onTextEditorChange={(value) => listEditorValue = value}
        />
      </List>
    </Page>
      
    
    
    <script>
      import { Page, Navbar, BlockTitle, BlockHeader, Block, TextEditor, List, ListInput } from 'framework7-svelte';
    
      let customButtons = {
        hr: {
          content: '<hr>',
          onClick(editor, buttonEl) {
            document.execCommand('insertHorizontalRule', false);
          },
        },
      };
    
      let customValue = `<p>Lorem, ipsum dolor sit amet consectetur adipisicing elit. Consequatur sunt, sapiente quis eligendi consectetur hic asperiores assumenda quidem dolore quasi iusto tenetur commodi qui ullam sint sed alias! Consequatur, dolor!</p>
          <p>Provident reiciendis exercitationem reprehenderit amet repellat laborum, sequi id quam quis quo quos facere veniam ad libero dolorum animi. Nobis, illum culpa explicabo dolorem vitae ut dolor at reprehenderit magnam?</p>
          <p>Qui, animi. Dolores dicta, nobis aut expedita enim eum assumenda modi, blanditiis voluptatibus excepturi non pariatur. Facilis fugit facere sequi molestias nemo in, suscipit inventore consequuntur, repellat perferendis, voluptas odit.</p>
          <p>Tempora voluptates, doloribus architecto eligendi numquam facilis perspiciatis autem quam voluptas maxime ratione harum laudantium cum deleniti. In, alias deserunt voluptatibus eligendi libero nobis est unde et perspiciatis cumque voluptatum.</p>
          <p>Quam error doloribus qui laboriosam eligendi. Aspernatur quam pariatur perspiciatis reprehenderit atque dicta culpa, aut rem? Assumenda, quibusdam? Reprehenderit necessitatibus facere nemo iure maiores porro voluptates accusamus quibusdam. Nesciunt, assumenda?</p>`;
    
      let listEditorValue = '';
    </script>