Textarea Component API

matestack_form my_form_config do
  form_textarea key: :foo, #...


key - required

Defines the key which should be used when posting the form data to the server.


Defines the placeholder.


Defines the label which will be rendered right before the textarea tag. You can also use the label component in order to create more complex label structures.


If set to true, HTML validations will be triggered on form submit.


If given, this value will be the initial value of the input. If used in an edit form of a given ActiveRecord model, the init value will be automatically derived from the model itself.

Custom Textarea

If you want to create your own textarea component, that's easily done since v.1.3.0.

  • Create your own Ruby component:


class Components::MyFormTextarea < Matestack::Ui::VueJs::Components::Form::Textarea

  vue_name "my-form-textarea"

  # optionally add some data here, which will be accessible within your Vue.js component
  # Make sure to merge your custom data into super. That way you're still able to bootstrap
  # your custom component with the base vue_props
  def vue_props
      foo: "bar"

  def response
    # exactly one root element is required since this is a Vue.js component template
    div do
      label text: "my form textarea"
      textarea textarea_attributes

  • Create the corresponding Vue.js component:


const myFormTextarea = {
  mixins: [MatestackUiVueJs.componentMixin, MatestackUiVueJs.formTextareaMixin],
  template: MatestackUiVueJs.componentHelpers.inlineTemplate,
  data() {
    return {};
  methods: {
    afterInitialize: function(value){
      // optional: if you need to modify the initial value
      // use this.setValue(xyz) in order to change the value
      // this method can be used in other methods or mounted hook of this component as well!
  mounted: function(){
    // use/initialize any third party library here
    // you can access the default initial value via this.componentConfig["init_value"]
    // if you need to, you can access your own component config data which added
    // within the prepare method of the corresponding Ruby class
    // this.componentConfig["foo"] would be "bar" in this case
export default myFormTextarea

// and register in your application js file like:
appInstance.component('my-form-textarea', myFormTextarea) // register at appInstance
  • Don't forget to require the custom component JavaScript according to your JS setup!

  • Finally, use it within a matestack_form:

matestack_form some_form_config do
  Components::MyFormTextarea.call(key: :foo)

Last updated